instance_profiles

Creates, updates, deletes or gets an instance_profile resource or lists instance_profiles in a region

Overview

Name	instance_profiles
Type	Resource
Description	Resource schema for AWS::DMS::InstanceProfile.
Id	aws.dms.instance_profiles

Fields

Name	Datatype	Description
instance_profile_arn	string	The property describes an ARN of the instance profile.
instance_profile_identifier	string	The property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn
availability_zone	string	The property describes an availability zone of the instance profile.
description	string	The optional description of the instance profile.
kms_key_arn	string	The property describes kms key arn for the instance profile.
publicly_accessible	boolean	The property describes the publicly accessible of the instance profile
network_type	string	The property describes a network type for the instance profile.
instance_profile_name	string	The property describes a name for the instance profile.
instance_profile_creation_time	string	The property describes a creating time of the instance profile.
subnet_group_identifier	string	The property describes a subnet group identifier for the instance profile.
vpc_security_groups	array	The property describes vps security groups for the instance profile.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all instance_profiles in a region.

SELECT
region,
instance_profile_arn,
instance_profile_identifier,
availability_zone,
description,
kms_key_arn,
publicly_accessible,
network_type,
instance_profile_name,
instance_profile_creation_time,
subnet_group_identifier,
vpc_security_groups,
tags
FROM aws.dms.instance_profiles
WHERE region = 'us-east-1';

Gets all properties from an individual instance_profile.

SELECT
region,
instance_profile_arn,
instance_profile_identifier,
availability_zone,
description,
kms_key_arn,
publicly_accessible,
network_type,
instance_profile_name,
instance_profile_creation_time,
subnet_group_identifier,
vpc_security_groups,
tags
FROM aws.dms.instance_profiles
WHERE region = 'us-east-1' AND data__Identifier = '<InstanceProfileArn>';

INSERT example

Use the following StackQL query and manifest file to create a new instance_profile resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.dms.instance_profiles (
 InstanceProfileIdentifier,
 AvailabilityZone,
 Description,
 KmsKeyArn,
 PubliclyAccessible,
 NetworkType,
 InstanceProfileName,
 SubnetGroupIdentifier,
 VpcSecurityGroups,
 Tags,
 region
)
SELECT 
'{{ InstanceProfileIdentifier }}',
 '{{ AvailabilityZone }}',
 '{{ Description }}',
 '{{ KmsKeyArn }}',
 '{{ PubliclyAccessible }}',
 '{{ NetworkType }}',
 '{{ InstanceProfileName }}',
 '{{ SubnetGroupIdentifier }}',
 '{{ VpcSecurityGroups }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.dms.instance_profiles (
 InstanceProfileIdentifier,
 AvailabilityZone,
 Description,
 KmsKeyArn,
 PubliclyAccessible,
 NetworkType,
 InstanceProfileName,
 SubnetGroupIdentifier,
 VpcSecurityGroups,
 Tags,
 region
)
SELECT 
 '{{ InstanceProfileIdentifier }}',
 '{{ AvailabilityZone }}',
 '{{ Description }}',
 '{{ KmsKeyArn }}',
 '{{ PubliclyAccessible }}',
 '{{ NetworkType }}',
 '{{ InstanceProfileName }}',
 '{{ SubnetGroupIdentifier }}',
 '{{ VpcSecurityGroups }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: instance_profile
    props:
      - name: InstanceProfileIdentifier
        value: '{{ InstanceProfileIdentifier }}'
      - name: AvailabilityZone
        value: '{{ AvailabilityZone }}'
      - name: Description
        value: '{{ Description }}'
      - name: KmsKeyArn
        value: '{{ KmsKeyArn }}'
      - name: PubliclyAccessible
        value: '{{ PubliclyAccessible }}'
      - name: NetworkType
        value: '{{ NetworkType }}'
      - name: InstanceProfileName
        value: '{{ InstanceProfileName }}'
      - name: SubnetGroupIdentifier
        value: '{{ SubnetGroupIdentifier }}'
      - name: VpcSecurityGroups
        value:
          - '{{ VpcSecurityGroups[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.dms.instance_profiles
WHERE data__Identifier = '<InstanceProfileArn>'
AND region = 'us-east-1';

Permissions

To operate on the instance_profiles resource, the following permissions are required:

Create

dms:CreateInstanceProfile,
dms:ListInstanceProfiles,
dms:DescribeInstanceProfiles,
dms:AddTagsToResource,
dms:ListTagsForResource

Read

dms:ListInstanceProfiles,
dms:DescribeInstanceProfiles,
dms:ListTagsForResource

Update

dms:UpdateInstanceProfile,
dms:ModifyInstanceProfile,
dms:AddTagsToResource,
dms:RemoveTagsToResource,
dms:ListTagsForResource

Delete

dms:DeleteInstanceProfile

List

dms:ListInstanceProfiles,
dms:DescribeInstanceProfiles,
dms:ListTagsForResource