resource_configurations

Creates, updates, deletes, gets or lists a resource_configurations resource.

Overview

Name	resource_configurations
Type	Resource
Id	aws.vpc_lattice.resource_configurations

Fields

The following fields are returned by SELECT queries:

get_resource_configuration

Name	Datatype	Description
id	string	The ID of the resource configuration. (pattern: <code>rcfg-[0-9a-z]{17}</code>)
name	string	The name of the resource configuration. (pattern: <code>(?!rcfg-)(?![-])(?!.[-]$)(?!.[-]{2})[a-z0-9-]+</code>)
allow_association_to_shareable_service_network	boolean	Specifies whether the resource configuration is associated with a sharable service network.
amazon_managed	boolean	Indicates whether the resource configuration was created and is managed by Amazon.
arn	string	The Amazon Resource Name (ARN) of the resource configuration. (pattern: <code>arn:[a-z0-9f-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}</code>)
created_at	string (date-time)	The date and time that the resource configuration was created, in ISO-8601 format.
custom_domain_name	string	The custom domain name of the resource configuration.
domain_verification_arn	string	The ARN of the domain verification. (pattern: <code>arn:[a-z0-9f-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:domainverification/dv-[a-fA-F0-9]{17}</code>)
domain_verification_id	string	The domain verification ID. (pattern: <code>dv-[a-fA-F0-9]{17}</code>)
domain_verification_status	string	The domain verification status. (VERIFIED, PENDING, VERIFICATION_TIMED_OUT)
failure_reason	string	The reason the create-resource-configuration request failed.
group_domain	string	(GROUP) The group domain for a group resource configuration. Any domains that you create for the child resource are subdomains of the group domain. Child resources inherit the verification status of the domain.
last_updated_at	string (date-time)	The most recent date and time that the resource configuration was updated, in ISO-8601 format.
port_ranges	array	The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30
protocol	string	The TCP protocol accepted by the specified resource configuration. (TCP)
resource_configuration_definition	object	Describes a resource configuration.
resource_configuration_group_id	string	The ID of the group resource configuration. (pattern: <code>rcfg-[0-9a-z]{17}</code>)
resource_gateway_id	string	The ID of the resource gateway used to connect to the resource configuration in a given VPC. You can specify the resource gateway identifier only for resource configurations with type SINGLE, GROUP, or ARN. (pattern: <code>rgw-[0-9a-z]{17}</code>)
status	string	The status of the resource configuration. (ACTIVE, CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, DELETE_IN_PROGRESS, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED)
type_	string	The type of resource configuration. SINGLE - A single resource. GROUP - A group of resources. CHILD - A single resource that is part of a group resource configuration. ARN - An Amazon Web Services resource. (GROUP, CHILD, SINGLE, ARN)

list_resource_configurations

Name	Datatype	Description
id	string	The ID of the resource configuration. (pattern: <code>rcfg-[0-9a-z]{17}</code>)
name	string	The name of the resource configuration. (pattern: <code>(?!rcfg-)(?![-])(?!.[-]$)(?!.[-]{2})[a-z0-9-]+</code>)
amazon_managed	boolean	Indicates whether the resource configuration was created and is managed by Amazon.
arn	string	The Amazon Resource Name (ARN) of the resource configuration. (pattern: <code>arn:[a-z0-9f-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}</code>)
created_at	string (date-time)	The date and time that the resource configuration was created, in ISO-8601 format.
custom_domain_name	string	The custom domain name.
domain_verification_id	string	The domain verification ID. (pattern: <code>dv-[a-fA-F0-9]{17}</code>)
group_domain	string	(GROUP) The group domain for a group resource configuration. Any domains that you create for the child resource are subdomains of the group domain. Child resources inherit the verification status of the domain.
last_updated_at	string (date-time)	The most recent date and time that the resource configuration was updated, in ISO-8601 format.
resource_configuration_group_id	string	The ID of the group resource configuration. (pattern: <code>rcfg-[0-9a-z]{17}</code>)
resource_gateway_id	string	The ID of the resource gateway. (pattern: <code>rgw-[0-9a-z]{17}</code>)
status	string	The status of the resource configuration. (ACTIVE, CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, DELETE_IN_PROGRESS, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED)
type_	string	The type of resource configuration. SINGLE - A single resource. GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration. CHILD - A single resource that is part of a group resource configuration. ARN - An Amazon Web Services resource. (GROUP, CHILD, SINGLE, ARN)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_configuration	select	resource_configuration_identifier, region		Retrieves information about the specified resource configuration.
list_resource_configurations	select	region	resourceGatewayIdentifier, resourceConfigurationGroupIdentifier, domainVerificationIdentifier, maxResults, nextToken	Lists the resource configurations owned by or shared with this account.
create_resource_configuration	insert	region, name, type		Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.
update_resource_configuration	update	resource_configuration_identifier, region		Updates the specified resource configuration.
delete_resource_configuration	delete	resource_configuration_identifier, region		Deletes the specified resource configuration.

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)
resource_configuration_identifier	string	The ID or ARN of the resource configuration.
domainVerificationIdentifier	string	The domain verification ID.
maxResults	integer	The maximum page size.
nextToken	string	A pagination token for the next page of results.
resourceConfigurationGroupIdentifier	string	The ID of the resource configuration of type Group.
resourceGatewayIdentifier	string	The ID of the resource gateway for the resource configuration.

SELECT examples

get_resource_configuration

Retrieves information about the specified resource configuration.

SELECT
id,
name,
allow_association_to_shareable_service_network,
amazon_managed,
arn,
created_at,
custom_domain_name,
domain_verification_arn,
domain_verification_id,
domain_verification_status,
failure_reason,
group_domain,
last_updated_at,
port_ranges,
protocol,
resource_configuration_definition,
resource_configuration_group_id,
resource_gateway_id,
status,
type_
FROM aws.vpc_lattice.resource_configurations
WHERE resource_configuration_identifier = '{{ resource_configuration_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_resource_configurations

Lists the resource configurations owned by or shared with this account.

SELECT
id,
name,
amazon_managed,
arn,
created_at,
custom_domain_name,
domain_verification_id,
group_domain,
last_updated_at,
resource_configuration_group_id,
resource_gateway_id,
status,
type_
FROM aws.vpc_lattice.resource_configurations
WHERE region = '{{ region }}' -- required
AND resourceGatewayIdentifier = '{{ resourceGatewayIdentifier }}'
AND resourceConfigurationGroupIdentifier = '{{ resourceConfigurationGroupIdentifier }}'
AND domainVerificationIdentifier = '{{ domainVerificationIdentifier }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_resource_configuration

Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.

INSERT INTO aws.vpc_lattice.resource_configurations (
name,
type,
portRanges,
protocol,
resourceGatewayIdentifier,
resourceConfigurationGroupIdentifier,
resourceConfigurationDefinition,
allowAssociationToShareableServiceNetwork,
customDomainName,
groupDomain,
domainVerificationIdentifier,
clientToken,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ portRanges }}',
'{{ protocol }}',
'{{ resourceGatewayIdentifier }}',
'{{ resourceConfigurationGroupIdentifier }}',
'{{ resourceConfigurationDefinition }}',
{{ allowAssociationToShareableServiceNetwork }},
'{{ customDomainName }}',
'{{ groupDomain }}',
'{{ domainVerificationIdentifier }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
allow_association_to_shareable_service_network,
arn,
created_at,
custom_domain_name,
domain_verification_arn,
domain_verification_id,
failure_reason,
group_domain,
port_ranges,
protocol,
resource_configuration_definition,
resource_configuration_group_id,
resource_gateway_id,
status,
type_
;

Manifest

# Description fields are for documentation purposes
- name: resource_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the resource_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: type
    value: "{{ type }}"
    valid_values: ['GROUP', 'CHILD', 'SINGLE', 'ARN']
  - name: portRanges
    value:
      - "{{ portRanges }}"
  - name: protocol
    value: "{{ protocol }}"
    valid_values: ['TCP']
  - name: resourceGatewayIdentifier
    value: "{{ resourceGatewayIdentifier }}"
  - name: resourceConfigurationGroupIdentifier
    value: "{{ resourceConfigurationGroupIdentifier }}"
  - name: resourceConfigurationDefinition
    description: |
      Describes a resource configuration.
    value:
      dnsResource:
        domainName: "{{ domainName }}"
        ipAddressType: "{{ ipAddressType }}"
      ipResource:
        ipAddress: "{{ ipAddress }}"
      arnResource:
        arn: "{{ arn }}"
  - name: allowAssociationToShareableServiceNetwork
    value: {{ allowAssociationToShareableServiceNetwork }}
  - name: customDomainName
    value: "{{ customDomainName }}"
  - name: groupDomain
    value: "{{ groupDomain }}"
  - name: domainVerificationIdentifier
    value: "{{ domainVerificationIdentifier }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_resource_configuration

Updates the specified resource configuration.

UPDATE aws.vpc_lattice.resource_configurations
SET 
resourceConfigurationDefinition = '{{ resourceConfigurationDefinition }}',
allowAssociationToShareableServiceNetwork = {{ allowAssociationToShareableServiceNetwork }},
portRanges = '{{ portRanges }}'
WHERE 
resource_configuration_identifier = '{{ resource_configuration_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
allow_association_to_shareable_service_network,
arn,
port_ranges,
protocol,
resource_configuration_definition,
resource_configuration_group_id,
resource_gateway_id,
status,
type_;

DELETE examples

delete_resource_configuration

Deletes the specified resource configuration.

DELETE FROM aws.vpc_lattice.resource_configurations
WHERE resource_configuration_identifier = '{{ resource_configuration_identifier }}' --required
AND region = '{{ region }}' --required
;