software.amazon.awsconstructs.services.s3stepfunction

Class S3ToStepFunction.Builder

java.lang.Object

software.amazon.awsconstructs.services.s3stepfunction.S3ToStepFunction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3ToStepFunction>

Enclosing class:

S3ToStepFunction

public static final class S3ToStepFunction.Builder
extends Object
implements software.amazon.jsii.Builder<S3ToStepFunction>

A fluent builder for S3ToStepFunction.

Method Summary

Modifier and Type	Method and Description
S3ToStepFunction.Builder	bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps) Optional user provided props to override the default props.
S3ToStepFunction	build()
static S3ToStepFunction.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
S3ToStepFunction.Builder	deployBucket(Boolean deployBucket) Whether to create a S3 Bucket or use an existing S3 Bucket.
S3ToStepFunction.Builder	deployCloudTrail(Boolean deployCloudTrail) Whether to deploy a Trail in AWS CloudTrail to log API events in Amazon S3.
S3ToStepFunction.Builder	eventRuleProps(software.amazon.awscdk.services.events.RuleProps eventRuleProps) User provided eventRuleProps to override the defaults.
S3ToStepFunction.Builder	existingBucketObj(software.amazon.awscdk.services.s3.Bucket existingBucketObj) Existing instance of S3 Bucket object.
S3ToStepFunction.Builder	stateMachineProps(software.amazon.awscdk.services.stepfunctions.StateMachineProps stateMachineProps) User provided StateMachineProps to override the defaults.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static S3ToStepFunction.Builder create(software.amazon.awscdk.core.Construct scope,
                                              String id)

Parameters:

scope - - represents the scope for all the resources. This parameter is required.

id - - this is a a scope-unique id. This parameter is required.

Returns:

a new instance of S3ToStepFunction.Builder.

stateMachineProps

public S3ToStepFunction.Builder stateMachineProps(software.amazon.awscdk.services.stepfunctions.StateMachineProps stateMachineProps)

User provided StateMachineProps to override the defaults.

Default: - None

Parameters:

stateMachineProps - User provided StateMachineProps to override the defaults. This parameter is required.

Returns:

this

bucketProps

public S3ToStepFunction.Builder bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps)

Optional user provided props to override the default props.

If deploy is set to true only then this property is required

Default: - Default props are used

Parameters:

bucketProps - Optional user provided props to override the default props. This parameter is required.

Returns:

this

deployBucket

public S3ToStepFunction.Builder deployBucket(Boolean deployBucket)

Whether to create a S3 Bucket or use an existing S3 Bucket.

If set to false, you must provide S3 Bucket as existingBucketObj

Default: - true

Parameters:

deployBucket - Whether to create a S3 Bucket or use an existing S3 Bucket. This parameter is required.

Returns:

this

deployCloudTrail

public S3ToStepFunction.Builder deployCloudTrail(Boolean deployCloudTrail)

Whether to deploy a Trail in AWS CloudTrail to log API events in Amazon S3.

Default: - true

Parameters:

deployCloudTrail - Whether to deploy a Trail in AWS CloudTrail to log API events in Amazon S3. This parameter is required.

Returns:

this

eventRuleProps

public S3ToStepFunction.Builder eventRuleProps(software.amazon.awscdk.services.events.RuleProps eventRuleProps)

User provided eventRuleProps to override the defaults.

Default: - None

Parameters:

eventRuleProps - User provided eventRuleProps to override the defaults. This parameter is required.

Returns:

this

existingBucketObj

public S3ToStepFunction.Builder existingBucketObj(software.amazon.awscdk.services.s3.Bucket existingBucketObj)

Existing instance of S3 Bucket object.

If deployBucket is set to false only then this property is required

Default: - None

Parameters:

existingBucketObj - Existing instance of S3 Bucket object. This parameter is required.

Returns:

this

build

public S3ToStepFunction build()

Specified by:

build in interface software.amazon.jsii.Builder<S3ToStepFunction>