CfnCloudConnectorPropsMixin

class aws_cdk.cfn_property_mixins.aws_ssm.CfnCloudConnectorPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::SSM::CloudConnector.

Enables AWS Systems Manager to manage resources in external cloud providers.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-cloudconnector.html
CloudformationResource:: AWS::SSM::CloudConnector
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.cfn_property_mixins import aws_ssm as ssm
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_cloud_connector_props_mixin = ssm.CfnCloudConnectorPropsMixin(ssm.CfnCloudConnectorMixinProps(
    config_connector_arn="configConnectorArn",
    configuration=ssm.CfnCloudConnectorPropsMixin.CloudConnectorConfigurationProperty(
        azure_configuration=ssm.CfnCloudConnectorPropsMixin.AzureConfigurationProperty(
            application_display_name="applicationDisplayName",
            application_id="applicationId",
            targets=ssm.CfnCloudConnectorPropsMixin.ConfigurationTargetsProperty(
                subscriptions=[ssm.CfnCloudConnectorPropsMixin.AzureSubscriptionProperty(
                    display_name="displayName",
                    id="id"
                )]
            ),
            tenant_display_name="tenantDisplayName",
            tenant_id="tenantId"
        )
    ),
    description="description",
    display_name="displayName",
    role_arn="roleArn",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::SSM::CloudConnector.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['configConnectorArn', 'configuration', 'description', 'displayName', 'roleArn', 'tags']

Static Methods

classmethod is_mixin(x)

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.

AzureConfigurationProperty

class CfnCloudConnectorPropsMixin.AzureConfigurationProperty(*, application_display_name=None, application_id=None, targets=None, tenant_display_name=None, tenant_id=None)

Bases: object

Configuration for connecting to Azure.

Parameters:

application_display_name (Optional[str]) – The display name of the Azure AD application.
application_id (Optional[str]) – The Azure AD application ID.
targets (Union[IResolvable, ConfigurationTargetsProperty, Dict[str, Any], None]) – The targets for the cloud connector. If omitted, the entire tenant is targeted.
tenant_display_name (Optional[str]) – The display name of the Azure AD tenant.
tenant_id (Optional[str]) – The Azure AD tenant ID. Cannot be changed after creation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-azureconfiguration.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.cfn_property_mixins import aws_ssm as ssm

azure_configuration_property = ssm.CfnCloudConnectorPropsMixin.AzureConfigurationProperty(
    application_display_name="applicationDisplayName",
    application_id="applicationId",
    targets=ssm.CfnCloudConnectorPropsMixin.ConfigurationTargetsProperty(
        subscriptions=[ssm.CfnCloudConnectorPropsMixin.AzureSubscriptionProperty(
            display_name="displayName",
            id="id"
        )]
    ),
    tenant_display_name="tenantDisplayName",
    tenant_id="tenantId"
)

Attributes

application_display_name

The display name of the Azure AD application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-azureconfiguration.html#cfn-ssm-cloudconnector-azureconfiguration-applicationdisplayname

application_id

The Azure AD application ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-azureconfiguration.html#cfn-ssm-cloudconnector-azureconfiguration-applicationid

targets

The targets for the cloud connector.

If omitted, the entire tenant is targeted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-azureconfiguration.html#cfn-ssm-cloudconnector-azureconfiguration-targets

tenant_display_name

The display name of the Azure AD tenant.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-azureconfiguration.html#cfn-ssm-cloudconnector-azureconfiguration-tenantdisplayname

tenant_id

The Azure AD tenant ID.

Cannot be changed after creation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-azureconfiguration.html#cfn-ssm-cloudconnector-azureconfiguration-tenantid

AzureSubscriptionProperty

class CfnCloudConnectorPropsMixin.AzureSubscriptionProperty(*, display_name=None, id=None)

Bases: object

An Azure subscription with its ID and optional display name.

Parameters:

display_name (Optional[str]) – The display name of the Azure subscription.
id (Optional[str]) – The Azure subscription ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-azuresubscription.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.cfn_property_mixins import aws_ssm as ssm

azure_subscription_property = ssm.CfnCloudConnectorPropsMixin.AzureSubscriptionProperty(
    display_name="displayName",
    id="id"
)

Attributes

display_name

The display name of the Azure subscription.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-azuresubscription.html#cfn-ssm-cloudconnector-azuresubscription-displayname

id

The Azure subscription ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-azuresubscription.html#cfn-ssm-cloudconnector-azuresubscription-id

CloudConnectorConfigurationProperty

class CfnCloudConnectorPropsMixin.CloudConnectorConfigurationProperty(*, azure_configuration=None)

Bases: object

The configuration for the cloud connector.

Currently supports Azure.

Parameters:: azure_configuration (Union[IResolvable, AzureConfigurationProperty, Dict[str, Any], None]) – Configuration for connecting to Azure.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-cloudconnectorconfiguration.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.cfn_property_mixins import aws_ssm as ssm

cloud_connector_configuration_property = ssm.CfnCloudConnectorPropsMixin.CloudConnectorConfigurationProperty(
    azure_configuration=ssm.CfnCloudConnectorPropsMixin.AzureConfigurationProperty(
        application_display_name="applicationDisplayName",
        application_id="applicationId",
        targets=ssm.CfnCloudConnectorPropsMixin.ConfigurationTargetsProperty(
            subscriptions=[ssm.CfnCloudConnectorPropsMixin.AzureSubscriptionProperty(
                display_name="displayName",
                id="id"
            )]
        ),
        tenant_display_name="tenantDisplayName",
        tenant_id="tenantId"
    )
)

Attributes

azure_configuration

Configuration for connecting to Azure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-cloudconnectorconfiguration.html#cfn-ssm-cloudconnector-cloudconnectorconfiguration-azureconfiguration

ConfigurationTargetsProperty

class CfnCloudConnectorPropsMixin.ConfigurationTargetsProperty(*, subscriptions=None)

Bases: object

The targets for the cloud connector.

If omitted, the entire tenant is targeted.

Parameters:: subscriptions (Union[IResolvable, Sequence[Union[IResolvable, AzureSubscriptionProperty, Dict[str, Any]]], None]) – List of Azure subscriptions.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-configurationtargets.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.cfn_property_mixins import aws_ssm as ssm

configuration_targets_property = ssm.CfnCloudConnectorPropsMixin.ConfigurationTargetsProperty(
    subscriptions=[ssm.CfnCloudConnectorPropsMixin.AzureSubscriptionProperty(
        display_name="displayName",
        id="id"
    )]
)

Attributes

subscriptions

List of Azure subscriptions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-cloudconnector-configurationtargets.html#cfn-ssm-cloudconnector-configurationtargets-subscriptions