software.amazon.awsconstructs.services.s3stepfunction

Interface S3ToStepFunctionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3ToStepFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.64.0 (build 4c1eae8)",
           date="2022-08-17T16:45:21.354Z")
public interface S3ToStepFunctionProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	S3ToStepFunctionProps.Builder A builder for S3ToStepFunctionProps
static class	S3ToStepFunctionProps.Jsii$Proxy An implementation for S3ToStepFunctionProps

Method Summary

Modifier and Type	Method and Description
static S3ToStepFunctionProps.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() 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 Detail

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.

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()

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 S3ToStepFunctionProps.Builder builder()

Returns:

a S3ToStepFunctionProps.Builder of S3ToStepFunctionProps