Skip to content

Commit

Permalink
feat(aws-s3-stepfunctions): added loggingBucketProps to s3-stepfuncti…
Browse files Browse the repository at this point in the history
…ons and s3-step-function (#414)

* added loggingBucketProps to s3-stepfunctions and s3-step-function

* updated prop comment and README

* added test for custom logging bucket in s3-stepfunctions

* update test names to s3-stepfunctions

* update test names to s3-step-function

* fixed optional text in construct props

* fixed optional text in construct props

* updated expected json output from customLoggingBucket
  • Loading branch information
mickychetta committed Oct 4, 2021
1 parent 51b1758 commit ed7bdfa
Show file tree
Hide file tree
Showing 9 changed files with 1,685 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,13 @@ _Parameters_
| **Name** | **Type** | **Description** |
|:-------------|:----------------|-----------------|
|existingBucketObj?|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.IBucket.html)|Existing instance of S3 Bucket object. If this is provided, then also providing bucketProps is an error. |
|bucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.BucketProps.html)|User provided props to override the default props for the S3 Bucket.|
|stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachineProps.html)|Optional user provided props to override the default props for sfn.StateMachine|
|bucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Bucket.|
|stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachineProps.html)|User provided props to override the default props for sfn.StateMachine|
|eventRuleProps?|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.RuleProps.html)|Optional user provided eventRuleProps to override the defaults|
|deployCloudTrail?|`boolean`|Whether to deploy a Trail in AWS CloudTrail to log API events in Amazon S3. Defaults to `true`.|
|createCloudWatchAlarms|`boolean`|Whether to create recommended CloudWatch alarms|
|logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|
|loggingBucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Logging Bucket.|

## Pattern Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface S3ToStepFunctionProps {
*/
readonly existingBucketObj?: s3.IBucket,
/**
* User provided props to override the default props for the S3 Bucket.
* Optional user provided props to override the default props for the S3 Bucket.
*
* @default - Default props are used
*/
Expand All @@ -44,7 +44,7 @@ export interface S3ToStepFunctionProps {
*/
readonly stateMachineProps: sfn.StateMachineProps,
/**
* User provided eventRuleProps to override the defaults
* Optional User provided eventRuleProps to override the defaults
*
* @default - None
*/
Expand All @@ -67,6 +67,12 @@ export interface S3ToStepFunctionProps {
* @default - Default props are used
*/
readonly logGroupProps?: logs.LogGroupProps
/**
* Optional user provided props to override the default props for the S3 Logging Bucket.
*
* @default - Default props are used
*/
readonly loggingBucketProps?: s3.BucketProps
}

export class S3ToStepFunction extends Construct {
Expand Down
Loading

0 comments on commit ed7bdfa

Please sign in to comment.