Package software.amazon.awsconstructs.services.s3stepfunctions

Interface S3ToStepfunctionsProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
S3ToStepfunctionsProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-19T19:26:23.013Z") public interface S3ToStepfunctionsProps extends software.amazon.jsii.JsiiSerializable

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    S3ToStepfunctionsProps.Builder
    A builder for S3ToStepfunctionsProps
    static final class 
    S3ToStepfunctionsProps.Jsii$Proxy
    An implementation for S3ToStepfunctionsProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static S3ToStepfunctionsProps.Builder
    builder()
     
    default software.amazon.awscdk.services.s3.BucketProps
    getBucketProps()
    Optional user provided props to override the default props for the S3 Bucket.
    default Boolean
    getCreateCloudWatchAlarms()
    Whether to create recommended CloudWatch alarms.
    default Boolean
    getDeployCloudTrail()
    Whether to deploy a Trail in AWS CloudTrail to log API events in Amazon S3.
    default software.amazon.awscdk.services.events.RuleProps
    getEventRuleProps()
    Optional user provided eventRuleProps to override the defaults.
    default software.amazon.awscdk.services.s3.IBucket
    getExistingBucketObj()
    Existing instance of S3 Bucket object, providing both this and bucketProps will cause an error.
    default software.amazon.awscdk.services.s3.BucketProps
    getLoggingBucketProps()
    Optional user provided props to override the default props for the S3 Logging Bucket.
    default software.amazon.awscdk.services.logs.LogGroupProps
    getLogGroupProps()
    Optional user provided props to override the default props for the CloudWatchLogs LogGroup.
    default Boolean
    getLogS3AccessLogs()
    Whether to turn on Access Logs for the S3 bucket with the associated storage costs.
    software.amazon.awscdk.services.stepfunctions.StateMachineProps
    getStateMachineProps()
    User provided StateMachineProps to override the defaults.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getStateMachineProps

      @NotNull software.amazon.awscdk.services.stepfunctions.StateMachineProps getStateMachineProps()
      User provided StateMachineProps to override the defaults.

      Default: - None

    • getBucketProps

      @Nullable default software.amazon.awscdk.services.s3.BucketProps getBucketProps()
      Optional user provided props to override the default props for the S3 Bucket.

      Default: - Default props are used

    • getCreateCloudWatchAlarms

      @Nullable default Boolean getCreateCloudWatchAlarms()
      Whether to create recommended CloudWatch alarms.

      Default: - Alarms are created

    • getDeployCloudTrail

      @Nullable default Boolean getDeployCloudTrail()
      Whether to deploy a Trail in AWS CloudTrail to log API events in Amazon S3.

      Default: - true

    • getEventRuleProps

      @Nullable default software.amazon.awscdk.services.events.RuleProps getEventRuleProps()
      Optional user provided eventRuleProps to override the defaults.

      Default: - None

    • getExistingBucketObj

      @Nullable default software.amazon.awscdk.services.s3.IBucket getExistingBucketObj()
      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

    • getLoggingBucketProps

      @Nullable default software.amazon.awscdk.services.s3.BucketProps getLoggingBucketProps()
      Optional user provided props to override the default props for the S3 Logging Bucket.

      Default: - Default props are used

    • getLogGroupProps

      @Nullable default software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()
      Optional user provided props to override the default props for the CloudWatchLogs LogGroup.

      Default: - Default props are used

    • getLogS3AccessLogs

      @Nullable default Boolean getLogS3AccessLogs()
      Whether to turn on Access Logs for the S3 bucket with the associated storage costs.

      Enabling Access Logging is a best practice.

      Default: - true

    • builder

      static S3ToStepfunctionsProps.Builder builder()
      Returns:
      a S3ToStepfunctionsProps.Builder of S3ToStepfunctionsProps