Package software.amazon.awscdk.services.stepfunctions

Interface CfnStateMachine.S3LocationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStateMachine.S3LocationProperty.Jsii$Proxy

Enclosing class:

CfnStateMachine

@Stability(Stable)
public static interface CfnStateMachine.S3LocationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.stepfunctions.*;
 S3LocationProperty s3LocationProperty = S3LocationProperty.builder()
         .bucket("bucket")
         .key("key")
         // the properties below are optional
         .version("version")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStateMachine.S3LocationProperty.Builder	A builder for CfnStateMachine.S3LocationProperty
static final class	CfnStateMachine.S3LocationProperty.Jsii$Proxy	An implementation for CfnStateMachine.S3LocationProperty

Method Summary

Modifier and Type	Method	Description
static CfnStateMachine.S3LocationProperty.Builder	builder()
String	getBucket()	The name of the S3 bucket where the state machine definition JSON or YAML file is stored.
String	getKey()	The name of the state machine definition file (Amazon S3 object name).
default String	getVersion()	For versioning-enabled buckets, a specific version of the state machine definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
String getBucket()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-bucket

getKey

@Stability(Stable)
@NotNull
String getKey()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-key

getVersion

@Stability(Stable)
@Nullable
default String getVersion()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-version

builder

@Stability(Stable)
static CfnStateMachine.S3LocationProperty.Builder builder()

Returns:

a CfnStateMachine.S3LocationProperty.Builder of CfnStateMachine.S3LocationProperty