io.github.hsiehshujeng.cdk.comprehend.s3olap

Class ComprehendS3olab.Builder

java.lang.Object

io.github.hsiehshujeng.cdk.comprehend.s3olap.ComprehendS3olab.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ComprehendS3olab>

Enclosing class:

ComprehendS3olab

@Stability(value=Stable)
public static final class ComprehendS3olab.Builder
extends Object
implements software.amazon.jsii.Builder<ComprehendS3olab>

A fluent builder for ComprehendS3olab.

Method Summary

Modifier and Type	Method and Description
ComprehendS3olab.Builder	accessControlLambdaConfig(AccessConrtolLambdaProps accessControlLambdaConfig) The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function.
ComprehendS3olab.Builder	adminRedactionLambdaConfig(RedactionLambdaProps adminRedactionLambdaConfig) The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`.
ComprehendS3olab.Builder	adminRoleConfig(AdminRoleProps adminRoleConfig) The manageable properties for the administrator IAM role in the redaction case.
ComprehendS3olab.Builder	billingRedactionLambdaConfig(RedactionLambdaProps billingRedactionLambdaConfig) The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`.
ComprehendS3olab.Builder	billingRoleConfig(BillingRoleProps billingRoleConfig) The manageable properties for the billing IAM role in the redaction case.
ComprehendS3olab	build()
static ComprehendS3olab.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
ComprehendS3olab.Builder	cusrtSupportRedactionLambdaConfig(RedactionLambdaProps cusrtSupportRedactionLambdaConfig) The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`.
ComprehendS3olab.Builder	custSupportRoleConfig(CustSupportRoleProps custSupportRoleConfig) The manageable properties for the customer support IAM role in the redaction case.
ComprehendS3olab.Builder	exampleFileDir(String exampleFileDir) The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put.
ComprehendS3olab.Builder	generalRoleConfig(GeneralRoleProps generalRoleConfig) The manageable properties for the IAM role used to access the `survey-results.txt` data.
ComprehendS3olab.Builder	generateRandomCharacters(Boolean generateRandomCharacters) For distinguish test and normal deployment.
ComprehendS3olab.Builder	s3AccessPointNames(S3AccessPointNames s3AccessPointNames) The names of the S3 access points for the access control case and redaction case.
ComprehendS3olab.Builder	surveyBucketPrefix(String surveyBucketPrefix) The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the access control case.
ComprehendS3olab.Builder	transcriptsBucketPrefix(String transcriptsBucketPrefix) The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the redaction case.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static ComprehendS3olab.Builder create(software.amazon.awscdk.core.Construct scope,
                                                                       String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ComprehendS3olab.Builder.

accessControlLambdaConfig

@Stability(value=Stable)
public ComprehendS3olab.Builder accessControlLambdaConfig(AccessConrtolLambdaProps accessControlLambdaConfig)

The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function.

Parameters:

accessControlLambdaConfig - The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function. This parameter is required.

Returns:

this

adminRedactionLambdaConfig

@Stability(value=Stable)
public ComprehendS3olab.Builder adminRedactionLambdaConfig(RedactionLambdaProps adminRedactionLambdaConfig)

The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`.

Parameters:

adminRedactionLambdaConfig - The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`. This parameter is required.

Returns:

this

adminRoleConfig

@Stability(value=Stable)
public ComprehendS3olab.Builder adminRoleConfig(AdminRoleProps adminRoleConfig)

The manageable properties for the administrator IAM role in the redaction case.

Parameters:

adminRoleConfig - The manageable properties for the administrator IAM role in the redaction case. This parameter is required.

Returns:

this

billingRedactionLambdaConfig

@Stability(value=Stable)
public ComprehendS3olab.Builder billingRedactionLambdaConfig(RedactionLambdaProps billingRedactionLambdaConfig)

The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`.

Parameters:

billingRedactionLambdaConfig - The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`. This parameter is required.

Returns:

this

billingRoleConfig

@Stability(value=Stable)
public ComprehendS3olab.Builder billingRoleConfig(BillingRoleProps billingRoleConfig)

The manageable properties for the billing IAM role in the redaction case.

Parameters:

billingRoleConfig - The manageable properties for the billing IAM role in the redaction case. This parameter is required.

Returns:

this

cusrtSupportRedactionLambdaConfig

@Stability(value=Stable)
public ComprehendS3olab.Builder cusrtSupportRedactionLambdaConfig(RedactionLambdaProps cusrtSupportRedactionLambdaConfig)

The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`.

Parameters:

cusrtSupportRedactionLambdaConfig - The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`. This parameter is required.

Returns:

this

custSupportRoleConfig

@Stability(value=Stable)
public ComprehendS3olab.Builder custSupportRoleConfig(CustSupportRoleProps custSupportRoleConfig)

The manageable properties for the customer support IAM role in the redaction case.

Parameters:

custSupportRoleConfig - The manageable properties for the customer support IAM role in the redaction case. This parameter is required.

Returns:

this

exampleFileDir

@Stability(value=Stable)
public ComprehendS3olab.Builder exampleFileDir(String exampleFileDir)

The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put.

DO NOT INCLUDE / in the end.

Default: __dirname

Parameters:

exampleFileDir - The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put. This parameter is required.

Returns:

this

generalRoleConfig

@Stability(value=Stable)
public ComprehendS3olab.Builder generalRoleConfig(GeneralRoleProps generalRoleConfig)

The manageable properties for the IAM role used to access the `survey-results.txt` data.

Parameters:

generalRoleConfig - The manageable properties for the IAM role used to access the `survey-results.txt` data. This parameter is required.

Returns:

this

generateRandomCharacters

@Stability(value=Stable)
public ComprehendS3olab.Builder generateRandomCharacters(Boolean generateRandomCharacters)

For distinguish test and normal deployment.

Default: true

Parameters:

generateRandomCharacters - For distinguish test and normal deployment. This parameter is required.

Returns:

this

s3AccessPointNames

@Stability(value=Stable)
public ComprehendS3olab.Builder s3AccessPointNames(S3AccessPointNames s3AccessPointNames)

The names of the S3 access points for the access control case and redaction case.

Parameters:

s3AccessPointNames - The names of the S3 access points for the access control case and redaction case. This parameter is required.

Returns:

this

surveyBucketPrefix

@Stability(value=Stable)
public ComprehendS3olab.Builder surveyBucketPrefix(String surveyBucketPrefix)

The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the access control case.

Default: 6 random words

Parameters:

surveyBucketPrefix - The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the access control case. This parameter is required.

Returns:

this

transcriptsBucketPrefix

@Stability(value=Stable)
public ComprehendS3olab.Builder transcriptsBucketPrefix(String transcriptsBucketPrefix)

The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the redaction case.

Default: 6 random words

Parameters:

transcriptsBucketPrefix - The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the redaction case. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public ComprehendS3olab build()

Specified by:

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