instance_profiles

Creates, updates, deletes, gets or lists an instance_profiles resource.

Overview

Name	instance_profiles
Type	Resource
Id	aws.dms.instance_profiles

Fields

The following fields are returned by SELECT queries:

describe_instance_profiles

Name	Datatype	Description
instance_profiles	array	A description of instance profiles.
marker	string	Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instance_profiles	select	region		Returns a paginated list of instance profiles for your account in the current region. Required permissions: dms:ListInstanceProfiles. For more information, see Actions, resources, and condition keys for Database Migration Service.
create_instance_profile	insert	region		Creates the instance profile using the specified parameters. Required permissions: dms:CreateInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service.
modify_instance_profile	update	region, InstanceProfileIdentifier		Modifies the specified instance profile using the provided parameters. Required permissions: dms:UpdateInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.
delete_instance_profile	delete	region		Deletes the specified instance profile. Required permissions: dms:DeleteInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_instance_profiles

Returns a paginated list of instance profiles for your account in the current region. Required permissions: dms:ListInstanceProfiles. For more information, see Actions, resources, and condition keys for Database Migration Service.

SELECT
instance_profiles,
marker
FROM aws.dms.instance_profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_instance_profile

Creates the instance profile using the specified parameters. Required permissions: dms:CreateInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service.

INSERT INTO aws.dms.instance_profiles (
AvailabilityZone,
KmsKeyArn,
PubliclyAccessible,
Tags,
NetworkType,
InstanceProfileName,
Description,
SubnetGroupIdentifier,
VpcSecurityGroups,
region
)
SELECT 
'{{ AvailabilityZone }}',
'{{ KmsKeyArn }}',
{{ PubliclyAccessible }},
'{{ Tags }}',
'{{ NetworkType }}',
'{{ InstanceProfileName }}',
'{{ Description }}',
'{{ SubnetGroupIdentifier }}',
'{{ VpcSecurityGroups }}',
'{{ region }}'
RETURNING
instance_profile
;

Manifest

# Description fields are for documentation purposes
- name: instance_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the instance_profiles resource.
  - name: AvailabilityZone
    value: "{{ AvailabilityZone }}"
    description: |
      The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d.
  - name: KmsKeyArn
    value: "{{ KmsKeyArn }}"
    description: |
      The Amazon Resource Name (ARN) of the 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 DMS uses an Amazon Web Services owned encryption key to encrypt your resources.
  - name: PubliclyAccessible
    value: {{ PubliclyAccessible }}
    description: |
      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.
  - name: Tags
    description: |
      One or more tags to be assigned to the instance profile.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
        ResourceArn: "{{ ResourceArn }}"
  - name: NetworkType
    value: "{{ NetworkType }}"
    description: |
      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.
  - name: InstanceProfileName
    value: "{{ InstanceProfileName }}"
    description: |
      A user-friendly name for the instance profile.
  - name: Description
    value: "{{ Description }}"
    description: |
      A user-friendly description of the instance profile.
  - name: SubnetGroupIdentifier
    value: "{{ SubnetGroupIdentifier }}"
    description: |
      A subnet group to associate with the instance profile.
  - name: VpcSecurityGroups
    value:
      - "{{ VpcSecurityGroups }}"
    description: |
      Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.

UPDATE examples

modify_instance_profile

Modifies the specified instance profile using the provided parameters. Required permissions: dms:UpdateInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.

UPDATE aws.dms.instance_profiles
SET 
InstanceProfileIdentifier = '{{ InstanceProfileIdentifier }}',
AvailabilityZone = '{{ AvailabilityZone }}',
KmsKeyArn = '{{ KmsKeyArn }}',
PubliclyAccessible = {{ PubliclyAccessible }},
NetworkType = '{{ NetworkType }}',
InstanceProfileName = '{{ InstanceProfileName }}',
Description = '{{ Description }}',
SubnetGroupIdentifier = '{{ SubnetGroupIdentifier }}',
VpcSecurityGroups = '{{ VpcSecurityGroups }}'
WHERE 
region = '{{ region }}' --required
AND InstanceProfileIdentifier = '{{ InstanceProfileIdentifier }}' --required
RETURNING
instance_profile;

DELETE examples

delete_instance_profile

Deletes the specified instance profile. Required permissions: dms:DeleteInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile.

DELETE FROM aws.dms.instance_profiles
WHERE region = '{{ region }}' --required
;