CfnDedicatedIpPoolPropsMixin

class aws_cdk.cfn_property_mixins.aws_pinpointemail.CfnDedicatedIpPoolPropsMixin(props, *, strategy=None)

Bases: Mixin

A request to create a new dedicated IP pool.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-dedicatedippool.html

CloudformationResource:

AWS::PinpointEmail::DedicatedIpPool

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_pinpointemail as pinpointemail
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_dedicated_ip_pool_props_mixin = pinpointemail.CfnDedicatedIpPoolPropsMixin(pinpointemail.CfnDedicatedIpPoolMixinProps(
    pool_name="poolName",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::PinpointEmail::DedicatedIpPool.

Parameters:
  • props (Union[CfnDedicatedIpPoolMixinProps, 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 = ['poolName', '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.

TagsProperty

class CfnDedicatedIpPoolPropsMixin.TagsProperty(*, key=None, value=None)

Bases: object

An object that defines the tags (keys and values) that you want to associate with the dedicated IP pool.

Parameters:
  • key (Optional[str]) – One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character. If you specify tags for the dedicated IP pool, then this value is required.

  • value (Optional[str]) – The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-dedicatedippool-tags.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_pinpointemail as pinpointemail

tags_property = pinpointemail.CfnDedicatedIpPoolPropsMixin.TagsProperty(
    key="key",
    value="value"
)

Attributes

key

One part of a key-value pair that defines a tag.

The maximum length of a tag key is 128 characters. The minimum length is 1 character.

If you specify tags for the dedicated IP pool, then this value is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-dedicatedippool-tags.html#cfn-pinpointemail-dedicatedippool-tags-key

value

The optional part of a key-value pair that defines a tag.

The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-dedicatedippool-tags.html#cfn-pinpointemail-dedicatedippool-tags-value