CfnInstanceProfileProps

class aws_cdk.aws_dms.CfnInstanceProfileProps(*, availability_zone=None, description=None, instance_profile_identifier=None, instance_profile_name=None, kms_key_arn=None, network_type=None, publicly_accessible=None, subnet_group_identifier=None, tags=None, vpc_security_groups=None)

Bases: object

Properties for defining a CfnInstanceProfile.

Parameters:

availability_zone (Optional[str]) – The Availability Zone where the instance profile runs.
description (Optional[str]) – A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
instance_profile_identifier (Optional[str]) – The identifier of the instance profile. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can’t end with a hyphen, or contain two consecutive hyphens.
instance_profile_name (Optional[str]) – The user-friendly name for the instance profile.
kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the connection parameters for the instance profile. If you don’t specify a value for the KmsKeyArn parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .
network_type (Optional[str]) – Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
publicly_accessible (Union[bool, IResolvable, None]) – Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true . Default: - false
subnet_group_identifier (Optional[str]) – The identifier of the subnet group that is associated with the instance profile.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.
vpc_security_groups (Optional[Sequence[str]]) – The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.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 import aws_dms as dms

cfn_instance_profile_props = dms.CfnInstanceProfileProps(
    availability_zone="availabilityZone",
    description="description",
    instance_profile_identifier="instanceProfileIdentifier",
    instance_profile_name="instanceProfileName",
    kms_key_arn="kmsKeyArn",
    network_type="networkType",
    publicly_accessible=False,
    subnet_group_identifier="subnetGroupIdentifier",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_security_groups=["vpcSecurityGroups"]
)

Attributes

availability_zone

The Availability Zone where the instance profile runs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-availabilityzone

description

A description of the instance profile.

Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-description

instance_profile_identifier

The identifier of the instance profile.

Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can’t end with a hyphen, or contain two consecutive hyphens.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-instanceprofileidentifier

instance_profile_name

The user-friendly name for the instance profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-instanceprofilename

kms_key_arn

The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the connection parameters for the instance profile.

If you don’t specify a value for the KmsKeyArn parameter, then AWS DMS uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-kmskeyarn

network_type

Specifies the network type for the instance profile.

A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-networktype

publicly_accessible

Specifies the accessibility options for the instance profile.

A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true .

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-publiclyaccessible

subnet_group_identifier

The identifier of the subnet group that is associated with the instance profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-subnetgroupidentifier

tags

An array of key-value pairs to apply to this resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-tags

vpc_security_groups

The VPC security groups that are used with the instance profile.

The VPC security group must work with the VPC containing the instance profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-vpcsecuritygroups