CfnInstanceStorageConfigPropsMixin

class aws_cdk.mixins_preview.aws_connect.mixins.CfnInstanceStorageConfigPropsMixin(props, *, strategy=None)

Bases: Mixin

The storage configuration for the instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-instancestorageconfig.html
CloudformationResource:: AWS::Connect::InstanceStorageConfig
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

cfn_instance_storage_config_props_mixin = connect_mixins.CfnInstanceStorageConfigPropsMixin(connect_mixins.CfnInstanceStorageConfigMixinProps(
    instance_arn="instanceArn",
    kinesis_firehose_config=connect_mixins.CfnInstanceStorageConfigPropsMixin.KinesisFirehoseConfigProperty(
        firehose_arn="firehoseArn"
    ),
    kinesis_stream_config=connect_mixins.CfnInstanceStorageConfigPropsMixin.KinesisStreamConfigProperty(
        stream_arn="streamArn"
    ),
    kinesis_video_stream_config=connect_mixins.CfnInstanceStorageConfigPropsMixin.KinesisVideoStreamConfigProperty(
        encryption_config=connect_mixins.CfnInstanceStorageConfigPropsMixin.EncryptionConfigProperty(
            encryption_type="encryptionType",
            key_id="keyId"
        ),
        prefix="prefix",
        retention_period_hours=123
    ),
    resource_type="resourceType",
    s3_config=connect_mixins.CfnInstanceStorageConfigPropsMixin.S3ConfigProperty(
        bucket_name="bucketName",
        bucket_prefix="bucketPrefix",
        encryption_config=connect_mixins.CfnInstanceStorageConfigPropsMixin.EncryptionConfigProperty(
            encryption_type="encryptionType",
            key_id="keyId"
        )
    ),
    storage_type="storageType"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Connect::InstanceStorageConfig.

Parameters:

props (Union[CfnInstanceStorageConfigMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['instanceArn', 'kinesisFirehoseConfig', 'kinesisStreamConfig', 'kinesisVideoStreamConfig', 'resourceType', 's3Config', 'storageType']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EncryptionConfigProperty

class CfnInstanceStorageConfigPropsMixin.EncryptionConfigProperty(*, encryption_type=None, key_id=None)

Bases: object

The encryption configuration.

Parameters:

encryption_type (Optional[str]) – The type of encryption.
key_id (Optional[str]) – The full ARN of the encryption key. .. epigraph:: Be sure to provide the full ARN of the encryption key, not just the ID. Amazon Connect supports only KMS keys with the default key spec of `SYMMETRIC_DEFAULT <https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default>`_ .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-encryptionconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

encryption_config_property = connect_mixins.CfnInstanceStorageConfigPropsMixin.EncryptionConfigProperty(
    encryption_type="encryptionType",
    key_id="keyId"
)

Attributes

encryption_type

The type of encryption.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-encryptionconfig.html#cfn-connect-instancestorageconfig-encryptionconfig-encryptiontype

key_id

The full ARN of the encryption key.

Be sure to provide the full ARN of the encryption key, not just the ID.

Amazon Connect supports only KMS keys with the default key spec of `SYMMETRIC_DEFAULT <https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default>`_ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-encryptionconfig.html#cfn-connect-instancestorageconfig-encryptionconfig-keyid

KinesisFirehoseConfigProperty

class CfnInstanceStorageConfigPropsMixin.KinesisFirehoseConfigProperty(*, firehose_arn=None)

Bases: object

Configuration information of a Kinesis Data Firehose delivery stream.

Parameters:: firehose_arn (Optional[str]) – The Amazon Resource Name (ARN) of the delivery stream.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisfirehoseconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

kinesis_firehose_config_property = connect_mixins.CfnInstanceStorageConfigPropsMixin.KinesisFirehoseConfigProperty(
    firehose_arn="firehoseArn"
)

Attributes

firehose_arn

The Amazon Resource Name (ARN) of the delivery stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisfirehoseconfig.html#cfn-connect-instancestorageconfig-kinesisfirehoseconfig-firehosearn

KinesisStreamConfigProperty

class CfnInstanceStorageConfigPropsMixin.KinesisStreamConfigProperty(*, stream_arn=None)

Bases: object

Configuration information of a Kinesis data stream.

Parameters:: stream_arn (Optional[str]) – The Amazon Resource Name (ARN) of the data stream.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisstreamconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

kinesis_stream_config_property = connect_mixins.CfnInstanceStorageConfigPropsMixin.KinesisStreamConfigProperty(
    stream_arn="streamArn"
)

Attributes

stream_arn

The Amazon Resource Name (ARN) of the data stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisstreamconfig.html#cfn-connect-instancestorageconfig-kinesisstreamconfig-streamarn

KinesisVideoStreamConfigProperty

class CfnInstanceStorageConfigPropsMixin.KinesisVideoStreamConfigProperty(*, encryption_config=None, prefix=None, retention_period_hours=None)

Bases: object

Configuration information of a Kinesis video stream.

Parameters:

encryption_config (Union[IResolvable, EncryptionConfigProperty, Dict[str, Any], None]) – The encryption configuration.
prefix (Optional[str]) – The prefix of the video stream.
retention_period_hours (Union[int, float, None]) – 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. The default value is 0, indicating that the stream does not persist data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisvideostreamconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

kinesis_video_stream_config_property = connect_mixins.CfnInstanceStorageConfigPropsMixin.KinesisVideoStreamConfigProperty(
    encryption_config=connect_mixins.CfnInstanceStorageConfigPropsMixin.EncryptionConfigProperty(
        encryption_type="encryptionType",
        key_id="keyId"
    ),
    prefix="prefix",
    retention_period_hours=123
)

Attributes

encryption_config

The encryption configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisvideostreamconfig.html#cfn-connect-instancestorageconfig-kinesisvideostreamconfig-encryptionconfig

prefix

The prefix of the video stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisvideostreamconfig.html#cfn-connect-instancestorageconfig-kinesisvideostreamconfig-prefix

retention_period_hours

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.

The default value is 0, indicating that the stream does not persist data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisvideostreamconfig.html#cfn-connect-instancestorageconfig-kinesisvideostreamconfig-retentionperiodhours

S3ConfigProperty

class CfnInstanceStorageConfigPropsMixin.S3ConfigProperty(*, bucket_name=None, bucket_prefix=None, encryption_config=None)

Bases: object

Information about the Amazon Simple Storage Service (Amazon S3) storage type.

Parameters:

bucket_name (Optional[str]) – The S3 bucket name.
bucket_prefix (Optional[str]) – The S3 bucket prefix.
encryption_config (Union[IResolvable, EncryptionConfigProperty, Dict[str, Any], None]) – The Amazon S3 encryption configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-s3config.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

s3_config_property = connect_mixins.CfnInstanceStorageConfigPropsMixin.S3ConfigProperty(
    bucket_name="bucketName",
    bucket_prefix="bucketPrefix",
    encryption_config=connect_mixins.CfnInstanceStorageConfigPropsMixin.EncryptionConfigProperty(
        encryption_type="encryptionType",
        key_id="keyId"
    )
)

Attributes

bucket_name

The S3 bucket name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-s3config.html#cfn-connect-instancestorageconfig-s3config-bucketname

bucket_prefix

The S3 bucket prefix.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-s3config.html#cfn-connect-instancestorageconfig-s3config-bucketprefix

encryption_config

The Amazon S3 encryption configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-s3config.html#cfn-connect-instancestorageconfig-s3config-encryptionconfig