AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DMS::InstanceProfile

CfnInstanceProfile

Provides information that defines an instance profile.

Import

import { CfnInstanceProfile } from 'aws-cdk-lib/aws-dms';

Or use the module namespace:

import * as dms from 'aws-cdk-lib/aws-dms';
// dms.CfnInstanceProfile

Properties

Configuration passed to the constructor as CfnInstanceProfileProps.

availabilityZoneOptional
string

The Availability Zone where the instance profile runs.

descriptionOptional
string

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.

instanceProfileIdentifierOptional
string

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.

instanceProfileNameOptional
string

The user-friendly name for the instance profile.

kmsKeyArnOptional
string

The Amazon Resource Name (ARN) of the AWS 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 an AWS owned encryption key to encrypt your resources.

networkTypeOptional
string

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.

publiclyAccessibleOptional
boolean | IResolvable

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

subnetGroupIdentifierOptional
string

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

tagsOptional
CfnTag[]

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

vpcSecurityGroupsOptional
string[]

The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter