Package software.amazon.awscdk.cfnpropertymixins.services.forecast

Interface CfnDatasetPropsMixin.EncryptionConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatasetPropsMixin.EncryptionConfigProperty.Jsii$Proxy

Enclosing class:

CfnDatasetPropsMixin

@Stability(Stable)
public static interface CfnDatasetPropsMixin.EncryptionConfigProperty
extends software.amazon.jsii.JsiiSerializable

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

You can specify this optional object in the CreateDataset and CreatePredictor requests.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.forecast.*;
 EncryptionConfigProperty encryptionConfigProperty = EncryptionConfigProperty.builder()
         .kmsKeyArn("kmsKeyArn")
         .roleArn("roleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDatasetPropsMixin.EncryptionConfigProperty.Builder	builder()
default String	getKmsKeyArn()	The Amazon Resource Name (ARN) of the KMS key.
default String	getRoleArn()	The ARN of the IAM role that Amazon Forecast can assume to access the AWS key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

The Amazon Resource Name (ARN) of the KMS key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html#cfn-forecast-dataset-encryptionconfig-kmskeyarn

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

The ARN of the IAM role that Amazon Forecast can assume to access the AWS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html#cfn-forecast-dataset-encryptionconfig-rolearn

builder

@Stability(Stable)
static CfnDatasetPropsMixin.EncryptionConfigProperty.Builder builder()

Returns:

a CfnDatasetPropsMixin.EncryptionConfigProperty.Builder of CfnDatasetPropsMixin.EncryptionConfigProperty