software.amazon.awsconstructs.services.s3stepfunction

Class S3ToStepFunctionProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.s3stepfunction.S3ToStepFunctionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3ToStepFunctionProps>

Enclosing interface:

S3ToStepFunctionProps

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

A builder for S3ToStepFunctionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

stateMachineProps

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

Sets the value of S3ToStepFunctionProps.getStateMachineProps()

Parameters:

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

Returns:

this

bucketProps

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

Sets the value of S3ToStepFunctionProps.getBucketProps()

Parameters:

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

Returns:

this

createCloudWatchAlarms

public S3ToStepFunctionProps.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)

Sets the value of S3ToStepFunctionProps.getCreateCloudWatchAlarms()

Parameters:

createCloudWatchAlarms - Whether to create recommended CloudWatch alarms.

Returns:

this

deployCloudTrail

public S3ToStepFunctionProps.Builder deployCloudTrail(Boolean deployCloudTrail)

Sets the value of S3ToStepFunctionProps.getDeployCloudTrail()

Parameters:

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

Returns:

this

eventRuleProps

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

Sets the value of S3ToStepFunctionProps.getEventRuleProps()

Parameters:

eventRuleProps - Optional User provided eventRuleProps to override the defaults.

Returns:

this

existingBucketObj

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

Sets the value of S3ToStepFunctionProps.getExistingBucketObj()

Parameters:

existingBucketObj - Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error.

Returns:

this

loggingBucketProps

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

Sets the value of S3ToStepFunctionProps.getLoggingBucketProps()

Parameters:

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

Returns:

this

logGroupProps

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

Sets the value of S3ToStepFunctionProps.getLogGroupProps()

Parameters:

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

Returns:

this

logS3AccessLogs

public S3ToStepFunctionProps.Builder logS3AccessLogs(Boolean logS3AccessLogs)

Sets the value of S3ToStepFunctionProps.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 S3ToStepFunctionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of S3ToStepFunctionProps

Throws:

NullPointerException - if any required attribute was not provided