CfnTrustAnchorPropsMixin

class aws_cdk.mixins_preview.aws_rolesanywhere.mixins.CfnTrustAnchorPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a TrustAnchor.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-trustanchor.html
CloudformationResource:: AWS::RolesAnywhere::TrustAnchor
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_rolesanywhere import mixins as rolesanywhere_mixins

cfn_trust_anchor_props_mixin = rolesanywhere_mixins.CfnTrustAnchorPropsMixin(rolesanywhere_mixins.CfnTrustAnchorMixinProps(
    enabled=False,
    name="name",
    notification_settings=[rolesanywhere_mixins.CfnTrustAnchorPropsMixin.NotificationSettingProperty(
        channel="channel",
        enabled=False,
        event="event",
        threshold=123
    )],
    source=rolesanywhere_mixins.CfnTrustAnchorPropsMixin.SourceProperty(
        source_data=rolesanywhere_mixins.CfnTrustAnchorPropsMixin.SourceDataProperty(
            acm_pca_arn="acmPcaArn",
            x509_certificate_data="x509CertificateData"
        ),
        source_type="sourceType"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::RolesAnywhere::TrustAnchor.

Parameters:

props (Union[CfnTrustAnchorMixinProps, 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 = ['enabled', 'name', 'notificationSettings', 'source', 'tags']

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

NotificationSettingProperty

class CfnTrustAnchorPropsMixin.NotificationSettingProperty(*, channel=None, enabled=None, event=None, threshold=None)

Bases: object

Customizable notification settings that will be applied to notification events.

IAM Roles Anywhere consumes these settings while notifying across multiple channels - CloudWatch metrics, EventBridge, and AWS Health Dashboard .

Parameters:

channel (Optional[str]) – The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and AWS Health Dashboard to notify for an event. .. epigraph:: In the absence of a specific channel, IAM Roles Anywhere applies this setting to ‘ALL’ channels.
enabled (Union[bool, IResolvable, None]) – Indicates whether the notification setting is enabled.
event (Optional[str]) – The event to which this notification setting is applied.
threshold (Union[int, float, None]) – The number of days before a notification event. This value is required for a notification setting that is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.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_rolesanywhere import mixins as rolesanywhere_mixins

notification_setting_property = rolesanywhere_mixins.CfnTrustAnchorPropsMixin.NotificationSettingProperty(
    channel="channel",
    enabled=False,
    event="event",
    threshold=123
)

Attributes

channel

The specified channel of notification.

IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and AWS Health Dashboard to notify for an event. .. epigraph:

In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-channel

enabled

Indicates whether the notification setting is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-enabled

event

The event to which this notification setting is applied.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-event

threshold

The number of days before a notification event.

This value is required for a notification setting that is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-threshold

SourceDataProperty

class CfnTrustAnchorPropsMixin.SourceDataProperty(*, acm_pca_arn=None, x509_certificate_data=None)

Bases: object

A union object representing the data field of the TrustAnchor depending on its type.

Parameters:

acm_pca_arn (Optional[str]) – The root certificate of the Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. Included for trust anchors of type AWS_ACM_PCA . .. epigraph:: This field is not supported in your region.
x509_certificate_data (Optional[str]) – The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-sourcedata.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_rolesanywhere import mixins as rolesanywhere_mixins

source_data_property = rolesanywhere_mixins.CfnTrustAnchorPropsMixin.SourceDataProperty(
    acm_pca_arn="acmPcaArn",
    x509_certificate_data="x509CertificateData"
)

Attributes

acm_pca_arn

The root certificate of the Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests.

Included for trust anchors of type AWS_ACM_PCA . .. epigraph:

This field is not supported in your region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-sourcedata.html#cfn-rolesanywhere-trustanchor-sourcedata-acmpcaarn

x509_certificate_data

The PEM-encoded data for the certificate anchor.

Included for trust anchors of type CERTIFICATE_BUNDLE .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-sourcedata.html#cfn-rolesanywhere-trustanchor-sourcedata-x509certificatedata

SourceProperty

class CfnTrustAnchorPropsMixin.SourceProperty(*, source_data=None, source_type=None)

Bases: object

Object representing the TrustAnchor type and its related certificate data.

Parameters:

source_data (Union[IResolvable, SourceDataProperty, Dict[str, Any], None]) – A union object representing the data field of the TrustAnchor depending on its type.
source_type (Optional[str]) – The type of the TrustAnchor.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-source.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_rolesanywhere import mixins as rolesanywhere_mixins

source_property = rolesanywhere_mixins.CfnTrustAnchorPropsMixin.SourceProperty(
    source_data=rolesanywhere_mixins.CfnTrustAnchorPropsMixin.SourceDataProperty(
        acm_pca_arn="acmPcaArn",
        x509_certificate_data="x509CertificateData"
    ),
    source_type="sourceType"
)

Attributes

source_data

A union object representing the data field of the TrustAnchor depending on its type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-source.html#cfn-rolesanywhere-trustanchor-source-sourcedata

source_type

The type of the TrustAnchor.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-source.html#cfn-rolesanywhere-trustanchor-source-sourcetype