Package software.amazon.awsconstructs.services.s3stepfunctions

Class S3ToStepfunctionsProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.s3stepfunctions.S3ToStepfunctionsProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3ToStepfunctionsProps>

Enclosing interface:

S3ToStepfunctionsProps

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

A builder for S3ToStepfunctionsProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
S3ToStepfunctionsProps.Builder	bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps)	Sets the value of S3ToStepfunctionsProps.getBucketProps()
S3ToStepfunctionsProps	build()	Builds the configured instance.
S3ToStepfunctionsProps.Builder	createCloudWatchAlarms(Boolean createCloudWatchAlarms)	Sets the value of S3ToStepfunctionsProps.getCreateCloudWatchAlarms()
S3ToStepfunctionsProps.Builder	deployCloudTrail(Boolean deployCloudTrail)	Sets the value of S3ToStepfunctionsProps.getDeployCloudTrail()
S3ToStepfunctionsProps.Builder	eventRuleProps(software.amazon.awscdk.services.events.RuleProps eventRuleProps)	Sets the value of S3ToStepfunctionsProps.getEventRuleProps()
S3ToStepfunctionsProps.Builder	existingBucketObj(software.amazon.awscdk.services.s3.IBucket existingBucketObj)	Sets the value of S3ToStepfunctionsProps.getExistingBucketObj()
S3ToStepfunctionsProps.Builder	loggingBucketProps(software.amazon.awscdk.services.s3.BucketProps loggingBucketProps)	Sets the value of S3ToStepfunctionsProps.getLoggingBucketProps()
S3ToStepfunctionsProps.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)	Sets the value of S3ToStepfunctionsProps.getLogGroupProps()
S3ToStepfunctionsProps.Builder	logS3AccessLogs(Boolean logS3AccessLogs)	Sets the value of S3ToStepfunctionsProps.getLogS3AccessLogs()
S3ToStepfunctionsProps.Builder	stateMachineProps(software.amazon.awscdk.services.stepfunctions.StateMachineProps stateMachineProps)	Sets the value of S3ToStepfunctionsProps.getStateMachineProps()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

stateMachineProps

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

Sets the value of S3ToStepfunctionsProps.getStateMachineProps()

Parameters:

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

Returns:

this

bucketProps

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

Sets the value of S3ToStepfunctionsProps.getBucketProps()

Parameters:

bucketProps - Optional user provided props to override the default props for the S3 Bucket.

Returns:

this

createCloudWatchAlarms

public S3ToStepfunctionsProps.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)

Sets the value of S3ToStepfunctionsProps.getCreateCloudWatchAlarms()

Parameters:

createCloudWatchAlarms - Whether to create recommended CloudWatch alarms.

Returns:

this

deployCloudTrail

public S3ToStepfunctionsProps.Builder deployCloudTrail(Boolean deployCloudTrail)

Sets the value of S3ToStepfunctionsProps.getDeployCloudTrail()

Parameters:

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

Returns:

this

eventRuleProps

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

Sets the value of S3ToStepfunctionsProps.getEventRuleProps()

Parameters:

eventRuleProps - Optional user provided eventRuleProps to override the defaults.

Returns:

this

existingBucketObj

public S3ToStepfunctionsProps.Builder existingBucketObj(software.amazon.awscdk.services.s3.IBucket existingBucketObj)

Sets the value of S3ToStepfunctionsProps.getExistingBucketObj()

Parameters:

existingBucketObj - Existing instance of S3 Bucket object, providing both this and bucketProps will cause an error. The Amazon EventBridge property must be enabled in the existing bucket for the construct to work.

Returns:

this

loggingBucketProps

public S3ToStepfunctionsProps.Builder loggingBucketProps(software.amazon.awscdk.services.s3.BucketProps loggingBucketProps)

Sets the value of S3ToStepfunctionsProps.getLoggingBucketProps()

Parameters:

loggingBucketProps - Optional user provided props to override the default props for the S3 Logging Bucket.

Returns:

this

logGroupProps

public S3ToStepfunctionsProps.Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)

Sets the value of S3ToStepfunctionsProps.getLogGroupProps()

Parameters:

logGroupProps - Optional user provided props to override the default props for the CloudWatchLogs LogGroup.

Returns:

this

logS3AccessLogs

public S3ToStepfunctionsProps.Builder logS3AccessLogs(Boolean logS3AccessLogs)

Sets the value of S3ToStepfunctionsProps.getLogS3AccessLogs()

Parameters:

logS3AccessLogs - Whether to turn on Access Logs for the S3 bucket with the associated storage costs. Enabling Access Logging is a best practice.

Returns:

this

build

public S3ToStepfunctionsProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of S3ToStepfunctionsProps

Throws:

NullPointerException - if any required attribute was not provided