io.github.hsiehshujeng.cdk.comprehend.s3olap

Interface ComprehendS3olabProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ComprehendS3olabProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.31.0 (build 6fa403d)",
           date="2021-07-13T00:44:52.318Z")
 @Stability(value=Stable)
public interface ComprehendS3olabProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ComprehendS3olabProps.Builder	builder()
default AccessConrtolLambdaProps	getAccessControlLambdaConfig() The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function.
default RedactionLambdaProps	getAdminRedactionLambdaConfig() The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`.
default AdminRoleProps	getAdminRoleConfig() The manageable properties for the administrator IAM role in the redaction case.
default RedactionLambdaProps	getBillingRedactionLambdaConfig() The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`.
default BillingRoleProps	getBillingRoleConfig() The manageable properties for the billing IAM role in the redaction case.
default RedactionLambdaProps	getCusrtSupportRedactionLambdaConfig() The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`.
default CustSupportRoleProps	getCustSupportRoleConfig() The manageable properties for the customer support IAM role in the redaction case.
default String	getExampleFileDir() The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put.
default GeneralRoleProps	getGeneralRoleConfig() The manageable properties for the IAM role used to access the `survey-results.txt` data.
default Boolean	getGenerateRandomCharacters() For distinguish test and normal deployment.
default S3AccessPointNames	getS3AccessPointNames() The names of the S3 access points for the access control case and redaction case.
default String	getSurveyBucketPrefix() 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 String	getTranscriptsBucketPrefix() 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 interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessControlLambdaConfig

@Stability(value=Stable)
 @Nullable
default AccessConrtolLambdaProps getAccessControlLambdaConfig()

The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function.

getAdminRedactionLambdaConfig

@Stability(value=Stable)
 @Nullable
default RedactionLambdaProps getAdminRedactionLambdaConfig()

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

getAdminRoleConfig

@Stability(value=Stable)
 @Nullable
default AdminRoleProps getAdminRoleConfig()

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

getBillingRedactionLambdaConfig

@Stability(value=Stable)
 @Nullable
default RedactionLambdaProps getBillingRedactionLambdaConfig()

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

getBillingRoleConfig

@Stability(value=Stable)
 @Nullable
default BillingRoleProps getBillingRoleConfig()

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

getCusrtSupportRedactionLambdaConfig

@Stability(value=Stable)
 @Nullable
default RedactionLambdaProps getCusrtSupportRedactionLambdaConfig()

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

getCustSupportRoleConfig

@Stability(value=Stable)
 @Nullable
default CustSupportRoleProps getCustSupportRoleConfig()

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

getExampleFileDir

@Stability(value=Stable)
 @Nullable
default String getExampleFileDir()

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

DO NOT INCLUDE / in the end.

Default: __dirname

getGeneralRoleConfig

@Stability(value=Stable)
 @Nullable
default GeneralRoleProps getGeneralRoleConfig()

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

getGenerateRandomCharacters

@Stability(value=Stable)
 @Nullable
default Boolean getGenerateRandomCharacters()

For distinguish test and normal deployment.

Default: true

getS3AccessPointNames

@Stability(value=Stable)
 @Nullable
default S3AccessPointNames getS3AccessPointNames()

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

getSurveyBucketPrefix

@Stability(value=Stable)
 @Nullable
default String getSurveyBucketPrefix()

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

getTranscriptsBucketPrefix

@Stability(value=Stable)
 @Nullable
default String getTranscriptsBucketPrefix()

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

builder

@Stability(value=Stable)
static ComprehendS3olabProps.Builder builder()

Returns:

a ComprehendS3olabProps.Builder of ComprehendS3olabProps