CfnTopicRuleDestinationPropsMixin

class aws_cdk.mixins_preview.aws_iot.mixins.CfnTopicRuleDestinationPropsMixin(props, *, strategy=None)

Bases: Mixin

A topic rule destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicruledestination.html
CloudformationResource:: AWS::IoT::TopicRuleDestination
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_iot import mixins as iot_mixins

cfn_topic_rule_destination_props_mixin = iot_mixins.CfnTopicRuleDestinationPropsMixin(iot_mixins.CfnTopicRuleDestinationMixinProps(
    http_url_properties=iot_mixins.CfnTopicRuleDestinationPropsMixin.HttpUrlDestinationSummaryProperty(
        confirmation_url="confirmationUrl"
    ),
    status="status",
    vpc_properties=iot_mixins.CfnTopicRuleDestinationPropsMixin.VpcDestinationPropertiesProperty(
        role_arn="roleArn",
        security_groups=["securityGroups"],
        subnet_ids=["subnetIds"],
        vpc_id="vpcId"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoT::TopicRuleDestination.

Parameters:

props (Union[CfnTopicRuleDestinationMixinProps, 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 = ['httpUrlProperties', 'status', 'vpcProperties']

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

HttpUrlDestinationSummaryProperty

class CfnTopicRuleDestinationPropsMixin.HttpUrlDestinationSummaryProperty(*, confirmation_url=None)

Bases: object

HTTP URL destination properties.

Parameters:: confirmation_url (Optional[str]) – The URL used to confirm the HTTP topic rule destination URL.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-httpurldestinationsummary.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_iot import mixins as iot_mixins

http_url_destination_summary_property = iot_mixins.CfnTopicRuleDestinationPropsMixin.HttpUrlDestinationSummaryProperty(
    confirmation_url="confirmationUrl"
)

Attributes

confirmation_url

The URL used to confirm the HTTP topic rule destination URL.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-httpurldestinationsummary.html#cfn-iot-topicruledestination-httpurldestinationsummary-confirmationurl

VpcDestinationPropertiesProperty

class CfnTopicRuleDestinationPropsMixin.VpcDestinationPropertiesProperty(*, role_arn=None, security_groups=None, subnet_ids=None, vpc_id=None)

Bases: object

The properties of a virtual private cloud (VPC) destination.

Parameters:

role_arn (Optional[str]) – The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
security_groups (Optional[Sequence[str]]) – The security groups of the VPC destination.
subnet_ids (Optional[Sequence[str]]) – The subnet IDs of the VPC destination.
vpc_id (Optional[str]) – The ID of the VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.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_iot import mixins as iot_mixins

vpc_destination_properties_property = iot_mixins.CfnTopicRuleDestinationPropsMixin.VpcDestinationPropertiesProperty(
    role_arn="roleArn",
    security_groups=["securityGroups"],
    subnet_ids=["subnetIds"],
    vpc_id="vpcId"
)

Attributes

role_arn

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.html#cfn-iot-topicruledestination-vpcdestinationproperties-rolearn

security_groups

The security groups of the VPC destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.html#cfn-iot-topicruledestination-vpcdestinationproperties-securitygroups

subnet_ids

The subnet IDs of the VPC destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.html#cfn-iot-topicruledestination-vpcdestinationproperties-subnetids

vpc_id

The ID of the VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.html#cfn-iot-topicruledestination-vpcdestinationproperties-vpcid