EncryptionConfigProperty Struct
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.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_forecast as forecast } from 'aws-cdk-lib';
const encryptionConfigProperty: forecast.CfnDataset.EncryptionConfigProperty = {
kmsKeyArn: 'kmsKeyArn',
roleArn: 'roleArn',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_forecast as forecast
encryption_config_property = forecast.CfnDataset.EncryptionConfigProperty(
kms_key_arn="kmsKeyArn",
role_arn="roleArn"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.forecast.*;
EncryptionConfigProperty encryptionConfigProperty = EncryptionConfigProperty.builder()
.kmsKeyArn("kmsKeyArn")
.roleArn("roleArn")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Forecast;
var encryptionConfigProperty = new EncryptionConfigProperty {
KmsKeyArn = "kmsKeyArn",
RoleArn = "roleArn"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
encryptionConfigProperty := &EncryptionConfigProperty{
KmsKeyArn: jsii.String("kmsKeyArn"),
RoleArn: jsii.String("roleArn"),
}
Properties
kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*string #The Amazon Resource Name (ARN) of the KMS key.
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*string #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.