Resource: awsConnectInstanceStorageConfig
Provides an Amazon Connect Instance Storage Config resource. For more information see Amazon Connect: Getting Started
Example Usage
Storage Config Kinesis Firehose Config
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectInstanceStorageConfig.ConnectInstanceStorageConfig(
this,
"example",
{
instanceId: "${aws_connect_instance.example.id}",
resourceType: "CONTACT_TRACE_RECORDS",
storageConfig: {
kinesisFirehoseConfig: {
firehoseArn: "${aws_kinesis_firehose_delivery_stream.example.arn}",
},
storageType: "KINESIS_FIREHOSE",
},
}
);
Storage Config Kinesis Stream Config
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectInstanceStorageConfig.ConnectInstanceStorageConfig(
this,
"example",
{
instanceId: "${aws_connect_instance.example.id}",
resourceType: "CONTACT_TRACE_RECORDS",
storageConfig: {
kinesisStreamConfig: {
streamArn: "${aws_kinesis_stream.example.arn}",
},
storageType: "KINESIS_STREAM",
},
}
);
Storage Config Kinesis Video Stream Config
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectInstanceStorageConfig.ConnectInstanceStorageConfig(
this,
"example",
{
instanceId: "${aws_connect_instance.example.id}",
resourceType: "MEDIA_STREAMS",
storageConfig: {
kinesisVideoStreamConfig: {
encryptionConfig: {
encryptionType: "KMS",
keyId: "${aws_kms_key.example.arn}",
},
prefix: "example",
retentionPeriodHours: 3,
},
storageType: "KINESIS_VIDEO_STREAM",
},
}
);
Storage Config S3 Config
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectInstanceStorageConfig.ConnectInstanceStorageConfig(
this,
"example",
{
instanceId: "${aws_connect_instance.example.id}",
resourceType: "CHAT_TRANSCRIPTS",
storageConfig: {
s3Config: {
bucketName: "${aws_s3_bucket.example.id}",
bucketPrefix: "example",
},
storageType: "S3",
},
}
);
Storage Config S3 Config with Encryption Config
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectInstanceStorageConfig.ConnectInstanceStorageConfig(
this,
"example",
{
instanceId: "${aws_connect_instance.example.id}",
resourceType: "CHAT_TRANSCRIPTS",
storageConfig: {
s3Config: {
bucketName: "${aws_s3_bucket.example.id}",
bucketPrefix: "example",
encryptionConfig: {
encryptionType: "KMS",
keyId: "${aws_kms_key.example.arn}",
},
},
storageType: "S3",
},
}
);
Argument Reference
The following arguments are supported:
instanceId
- (Required) Specifies the identifier of the hosting Amazon Connect Instance.resourceType
- (Required) A valid resource type. Valid Values:CHAT_TRANSCRIPTS
|CALL_RECORDINGS
|SCHEDULED_REPORTS
|MEDIA_STREAMS
|CONTACT_TRACE_RECORDS
|AGENT_EVENTS
|REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
.storageConfig
- (Required) Specifies the storage configuration options for the Connect Instance. Documented below.
storageConfig
The storageConfig
configuration block supports the following arguments:
kinesisFirehoseConfig
- (Required iftype
is set toKINESIS_FIREHOSE
) A block that specifies the configuration of the Kinesis Firehose delivery stream. Documented below.kinesisStreamConfig
- (Required iftype
is set toKINESIS_STREAM
) A block that specifies the configuration of the Kinesis data stream. Documented below.kinesisVideoStreamConfig
- (Required iftype
is set toKINESIS_VIDEO_STREAM
) A block that specifies the configuration of the Kinesis video stream. Documented below.s3Config
- (Required iftype
is set tos3
) A block that specifies the configuration of S3 Bucket. Documented below.storageType
- (Required) A valid storage type. Valid Values:s3
|KINESIS_VIDEO_STREAM
|KINESIS_STREAM
|KINESIS_FIREHOSE
.
kinesisFirehoseConfig
The kinesisFirehoseConfig
configuration block supports the following arguments:
firehoseArn
- (Required) The Amazon Resource Name (ARN) of the delivery stream.
kinesisStreamConfig
The kinesisStreamConfig
configuration block supports the following arguments:
streamArn
- (Required) The Amazon Resource Name (ARN) of the data stream.
kinesisVideoStreamConfig
The kinesisVideoStreamConfig
configuration block supports the following arguments:
encryptionConfig
- (Required) The encryption configuration. Documented below.prefix
- (Required) The prefix of the video stream. Minimum length of1
. Maximum length of128
. When read from the state, the value returned is<prefix>Connect-<connectInstanceAlias>Contact
since the API appends additional details to theprefix
.retentionPeriodHours
- (Required) The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. Minimum value of0
. Maximum value of87600
. A value of0
, indicates that the stream does not persist data.
s3Config
The s3Config
configuration block supports the following arguments:
bucketName
- (Required) The S3 bucket name.bucketPrefix
- (Required) The S3 bucket prefix.encryptionConfig
- (Optional) The encryption configuration. Documented below.
encryptionConfig
The encryptionConfig
configuration block supports the following arguments:
encryptionType
- (Required) The type of encryption. Valid Values:kms
.keyId
- (Required) The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
associationId
- The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.id
- The identifier of the hosting Amazon Connect Instance,associationId
, andresourceType
separated by a colon (:
).
Import
Amazon Connect Instance Storage Configs can be imported using the instanceId
, associationId
, and resourceType
separated by a colon (:
), e.g.,