aws-cdk-lib.aws_stepfunctions.CfnStateMachine.S3LocationProperty

interface S3LocationProperty

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.CfnStateMachine.S3LocationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#CfnStateMachine_S3LocationProperty
Javasoftware.amazon.awscdk.services.stepfunctions.CfnStateMachine.S3LocationProperty
Pythonaws_cdk.aws_stepfunctions.CfnStateMachine.S3LocationProperty
TypeScript aws-cdk-lib » aws_stepfunctions » CfnStateMachine » S3LocationProperty

Defines the S3 bucket location where a state machine definition is stored.

The state machine definition must be a JSON or YAML file.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
const s3LocationProperty: stepfunctions.CfnStateMachine.S3LocationProperty = {
  bucket: 'bucket',
  key: 'key',

  // the properties below are optional
  version: 'version',
};

Properties

NameTypeDescription
bucketstringThe name of the S3 bucket where the state machine definition JSON or YAML file is stored.
keystringThe name of the state machine definition file (Amazon S3 object name).
version?stringFor versioning-enabled buckets, a specific version of the state machine definition.

bucket

Type: string

The name of the S3 bucket where the state machine definition JSON or YAML file is stored.


key

Type: string

The name of the state machine definition file (Amazon S3 object name).


version?

Type: string (optional)

For versioning-enabled buckets, a specific version of the state machine definition.