CfnPreferencesPropsMixin

class aws_cdk.mixins_preview.aws_ssmguiconnect.mixins.CfnPreferencesPropsMixin(props, *, strategy=None)

Bases: Mixin

Specify new or changed connection recording preferences for your AWS Systems Manager GUI Connect connections.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmguiconnect-preferences.html
CloudformationResource:: AWS::SSMGuiConnect::Preferences
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_ssmguiconnect import mixins as ssmguiconnect_mixins

cfn_preferences_props_mixin = ssmguiconnect_mixins.CfnPreferencesPropsMixin(ssmguiconnect_mixins.CfnPreferencesMixinProps(
    connection_recording_preferences=ssmguiconnect_mixins.CfnPreferencesPropsMixin.ConnectionRecordingPreferencesProperty(
        kms_key_arn="kmsKeyArn",
        recording_destinations=ssmguiconnect_mixins.CfnPreferencesPropsMixin.RecordingDestinationsProperty(
            s3_buckets=[ssmguiconnect_mixins.CfnPreferencesPropsMixin.S3BucketProperty(
                bucket_name="bucketName",
                bucket_owner="bucketOwner"
            )]
        )
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SSMGuiConnect::Preferences.

Parameters:

props (Union[CfnPreferencesMixinProps, 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 = ['connectionRecordingPreferences']

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

ConnectionRecordingPreferencesProperty

class CfnPreferencesPropsMixin.ConnectionRecordingPreferencesProperty(*, kms_key_arn=None, recording_destinations=None)

Bases: object

The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region .

This includes details such as which S3 bucket recordings are stored in.

Parameters:

kms_key_arn (Optional[str]) – The ARN of a AWS key that is used to encrypt data while it is being processed by the service. This key must exist in the same AWS Region as the node you start an RDP connection to.
recording_destinations (Union[IResolvable, RecordingDestinationsProperty, Dict[str, Any], None]) – Determines where recordings of RDP connections are stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-connectionrecordingpreferences.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_ssmguiconnect import mixins as ssmguiconnect_mixins

connection_recording_preferences_property = ssmguiconnect_mixins.CfnPreferencesPropsMixin.ConnectionRecordingPreferencesProperty(
    kms_key_arn="kmsKeyArn",
    recording_destinations=ssmguiconnect_mixins.CfnPreferencesPropsMixin.RecordingDestinationsProperty(
        s3_buckets=[ssmguiconnect_mixins.CfnPreferencesPropsMixin.S3BucketProperty(
            bucket_name="bucketName",
            bucket_owner="bucketOwner"
        )]
    )
)

Attributes

kms_key_arn

The ARN of a AWS key that is used to encrypt data while it is being processed by the service.

This key must exist in the same AWS Region as the node you start an RDP connection to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-connectionrecordingpreferences.html#cfn-ssmguiconnect-preferences-connectionrecordingpreferences-kmskeyarn

recording_destinations

Determines where recordings of RDP connections are stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-connectionrecordingpreferences.html#cfn-ssmguiconnect-preferences-connectionrecordingpreferences-recordingdestinations

RecordingDestinationsProperty

class CfnPreferencesPropsMixin.RecordingDestinationsProperty(*, s3_buckets=None)

Bases: object

Determines where recordings of RDP connections are stored.

Parameters:: s3_buckets (Union[IResolvable, Sequence[Union[IResolvable, S3BucketProperty, Dict[str, Any]]], None]) – The S3 bucket where RDP connection recordings are stored.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-recordingdestinations.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_ssmguiconnect import mixins as ssmguiconnect_mixins

recording_destinations_property = ssmguiconnect_mixins.CfnPreferencesPropsMixin.RecordingDestinationsProperty(
    s3_buckets=[ssmguiconnect_mixins.CfnPreferencesPropsMixin.S3BucketProperty(
        bucket_name="bucketName",
        bucket_owner="bucketOwner"
    )]
)

Attributes

s3_buckets

The S3 bucket where RDP connection recordings are stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-recordingdestinations.html#cfn-ssmguiconnect-preferences-recordingdestinations-s3buckets

S3BucketProperty

class CfnPreferencesPropsMixin.S3BucketProperty(*, bucket_name=None, bucket_owner=None)

Bases: object

The S3 bucket where RDP connection recordings are stored.

Parameters:

bucket_name (Optional[str]) – The name of the S3 bucket where RDP connection recordings are stored.
bucket_owner (Optional[str]) – The AWS account number that owns the S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-s3bucket.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_ssmguiconnect import mixins as ssmguiconnect_mixins

s3_bucket_property = ssmguiconnect_mixins.CfnPreferencesPropsMixin.S3BucketProperty(
    bucket_name="bucketName",
    bucket_owner="bucketOwner"
)

Attributes

bucket_name

The name of the S3 bucket where RDP connection recordings are stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-s3bucket.html#cfn-ssmguiconnect-preferences-s3bucket-bucketname

bucket_owner

The AWS account number that owns the S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-s3bucket.html#cfn-ssmguiconnect-preferences-s3bucket-bucketowner