aws-cdk-lib.aws_stepfunctions.CfnStateMachine.S3LocationProperty

S3LocationProperty Struct

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

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

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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

bucketstringbucketstrbucketStringBucketstringBucket*stringrequired#

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

keystringkeystrkeyStringKeystringKey*stringrequired#

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

versionstringversionstrversionStringVersionstringVersion*string#

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