Provides information that defines an instance profile.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::DMS::InstanceProfile",
"Properties" : {
"AvailabilityZone" : String,
"Description" : String,
"InstanceProfileIdentifier" : String,
"InstanceProfileName" : String,
"KmsKeyArn" : String,
"NetworkType" : String,
"PubliclyAccessible" : Boolean,
"SubnetGroupIdentifier" : String,
"Tags" : [ Tag, ... ],
"VpcSecurityGroups" : [ String, ... ]
}
}
YAML
Type: AWS::DMS::InstanceProfile
Properties:
AvailabilityZone: String
Description: String
InstanceProfileIdentifier: String
InstanceProfileName: String
KmsKeyArn: String
NetworkType: String
PubliclyAccessible: Boolean
SubnetGroupIdentifier: String
Tags:
- Tag
VpcSecurityGroups:
- String
Properties
AvailabilityZone-
The Availability Zone where the instance profile runs.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
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.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
InstanceProfileIdentifier-
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.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
InstanceProfileName-
The user-friendly name for the instance profile.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
KmsKeyArn-
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
KmsKeyArnparameter, 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.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
NetworkType-
Specifies the network type for the instance profile. A value of
IPV4represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value ofIPV6represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value ofDUALrepresents an instance profile with dual network type that supports IPv4 and IPv6 addressing.Required: No
Type: String
Allowed values:
IPV4 | DUALUpdate requires: No interruption
PubliclyAccessible-
Specifies the accessibility options for the instance profile. A value of
truerepresents an instance profile with a public IP address. A value offalserepresents an instance profile with a private IP address. The default value istrue.Required: No
Type: Boolean
Update requires: No interruption
SubnetGroupIdentifier-
The identifier of the subnet group that is associated with the instance profile.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
Property description not available.
Required: No
Type: Array of Tag
Update requires: No interruption
VpcSecurityGroups-
The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
Required: No
Type: Array of String
Update requires: No interruption
Return values
Ref
Fn::GetAtt
InstanceProfileArn-
The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
InstanceProfileCreationTime-
The time the instance profile was created.
