2.170.0

interface CfnInstanceProfileProps

LanguageType name
.NETAmazon.CDK.AWS.DMS.CfnInstanceProfileProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnInstanceProfileProps
Javasoftware.amazon.awscdk.services.dms.CfnInstanceProfileProps
Pythonaws_cdk.aws_dms.CfnInstanceProfileProps
TypeScript aws-cdk-lib » aws_dms » CfnInstanceProfileProps

Properties for defining a CfnInstanceProfile.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const cfnInstanceProfileProps: dms.CfnInstanceProfileProps = {
  availabilityZone: 'availabilityZone',
  description: 'description',
  instanceProfileIdentifier: 'instanceProfileIdentifier',
  instanceProfileName: 'instanceProfileName',
  kmsKeyArn: 'kmsKeyArn',
  networkType: 'networkType',
  publiclyAccessible: false,
  subnetGroupIdentifier: 'subnetGroupIdentifier',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcSecurityGroups: ['vpcSecurityGroups'],
};

Properties

NameTypeDescription
availabilityZone?stringThe Availability Zone where the instance profile runs.
description?stringA description of the instance profile.
instanceProfileIdentifier?stringThe identifier of the instance profile.
instanceProfileName?stringThe user-friendly name for the instance profile.
kmsKeyArn?stringThe Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the connection parameters for the instance profile.
networkType?stringSpecifies the network type for the instance profile.
publiclyAccessible?boolean | IResolvableSpecifies the accessibility options for the instance profile.
subnetGroupIdentifier?stringThe identifier of the subnet group that is associated with the instance profile.
tags?CfnTag[]An array of key-value pairs to apply to this resource.
vpcSecurityGroups?string[]The VPC security groups that are used with the instance profile.

availabilityZone?

Type: string (optional)

The Availability Zone where the instance profile runs.

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

description?

Type: string (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-description

instanceProfileIdentifier?

Type: string (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-instanceprofileidentifier

instanceProfileName?

Type: string (optional)

The user-friendly name for the instance profile.

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

kmsKeyArn?

Type: string (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-kmskeyarn

networkType?

Type: string (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-networktype

publiclyAccessible?

Type: boolean | IResolvable (optional, default: false)

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 .

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

subnetGroupIdentifier?

Type: string (optional)

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

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

tags?

Type: CfnTag[] (optional)

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

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

vpcSecurityGroups?

Type: string[] (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-vpcsecuritygroups

← PreviousNext →