Package software.amazon.awsconstructs.services.s3stepfunctions

Class S3ToStepfunctions.Builder

java.lang.Object
software.amazon.awsconstructs.services.s3stepfunctions.S3ToStepfunctions.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<S3ToStepfunctions>
Enclosing class:
S3ToStepfunctions
public static final class S3ToStepfunctions.Builder extends Object implements software.amazon.jsii.Builder<S3ToStepfunctions>
A fluent builder for S3ToStepfunctions.

  • Method Details

    • create

      public static S3ToStepfunctions.Builder create(software.constructs.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 S3ToStepfunctions.Builder.

    • stateMachineProps

      public S3ToStepfunctions.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 S3ToStepfunctions.Builder bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps)
      Optional user provided props to override the default props for the S3 Bucket.

      Default: - Default props are used

      Parameters:
      bucketProps - Optional user provided props to override the default props for the S3 Bucket. This parameter is required.
      Returns:
      this

    • createCloudWatchAlarms

      public S3ToStepfunctions.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)
      Whether to create recommended CloudWatch alarms.

      Default: - Alarms are created

      Parameters:
      createCloudWatchAlarms - Whether to create recommended CloudWatch alarms. This parameter is required.
      Returns:
      this

    • deployCloudTrail

      public S3ToStepfunctions.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 S3ToStepfunctions.Builder eventRuleProps(software.amazon.awscdk.services.events.RuleProps eventRuleProps)
      Optional user provided eventRuleProps to override the defaults.

      Default: - None

      Parameters:
      eventRuleProps - Optional user provided eventRuleProps to override the defaults. This parameter is required.
      Returns:
      this

    • existingBucketObj

      public S3ToStepfunctions.Builder existingBucketObj(software.amazon.awscdk.services.s3.IBucket 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.

      Default: - None

      Parameters:
      existingBucketObj - Existing instance of S3 Bucket object, providing both this and bucketProps will cause an error. This parameter is required.
      Returns:
      this

    • loggingBucketProps

      public S3ToStepfunctions.Builder loggingBucketProps(software.amazon.awscdk.services.s3.BucketProps loggingBucketProps)
      Optional user provided props to override the default props for the S3 Logging Bucket.

      Default: - Default props are used

      Parameters:
      loggingBucketProps - Optional user provided props to override the default props for the S3 Logging Bucket. This parameter is required.
      Returns:
      this

    • logGroupProps

      public S3ToStepfunctions.Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)
      Optional user provided props to override the default props for the CloudWatchLogs LogGroup.

      Default: - Default props are used

      Parameters:
      logGroupProps - Optional user provided props to override the default props for the CloudWatchLogs LogGroup. This parameter is required.
      Returns:
      this

    • logS3AccessLogs

      public S3ToStepfunctions.Builder logS3AccessLogs(Boolean logS3AccessLogs)
      Whether to turn on Access Logs for the S3 bucket with the associated storage costs.

      Enabling Access Logging is a best practice.

      Default: - true

      Parameters:
      logS3AccessLogs - Whether to turn on Access Logs for the S3 bucket with the associated storage costs. This parameter is required.
      Returns:
      this

    • build

      public S3ToStepfunctions build()
      Specified by:
      build in interface software.amazon.jsii.Builder<S3ToStepfunctions>
      Returns:
      a newly built instance of S3ToStepfunctions.