service_network_resource_associations

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

Overview

Name	service_network_resource_associations
Type	Resource
Id	aws.vpc_lattice.service_network_resource_associations

Fields

The following fields are returned by SELECT queries:

get_service_network_resource_association

Name	Datatype	Description
id	string	The ID of the association. (pattern: <code>snra-[0-9a-f]{17}</code>)
arn	string	The Amazon Resource Name (ARN) of the association. (pattern: <code>arn:[a-z0-9-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:servicenetworkresourceassociation/snra-[0-9a-f]{17}</code>)
created_at	string (date-time)	The date and time that the association was created, in ISO-8601 format.
created_by	string	The account that created the association. (pattern: <code>[0-9]{12}</code>)
dns_entry	object	The DNS entry for the service.
domain_verification_status	string	The domain verification status in the service network resource association. (VERIFIED, PENDING, VERIFICATION_TIMED_OUT)
failure_code	string	The failure code.
failure_reason	string	The reason the association request failed.
is_managed_association	boolean	Indicates whether the association is managed by Amazon.
last_updated_at	string (date-time)	The most recent date and time that the association was updated, in ISO-8601 format.
private_dns_enabled	boolean	Indicates if private DNS is enabled in the service network resource association.
private_dns_entry	object	The private DNS entry for the service.
resource_configuration_arn	string	The Amazon Resource Name (ARN) of the association. (pattern: <code>arn:[a-z0-9f-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}</code>)
resource_configuration_id	string	The ID of the resource configuration that is associated with the service network. (pattern: <code>rcfg-[0-9a-z]{17}</code>)
resource_configuration_name	string	The name of the resource configuration that is associated with the service network. (pattern: <code>(?!rcfg-)(?![-])(?!.[-]$)(?!.[-]{2})[a-z0-9-]+</code>)
service_network_arn	string	The Amazon Resource Name (ARN) of the service network that is associated with the resource configuration.
service_network_id	string	The ID of the service network that is associated with the resource configuration.
service_network_name	string	The name of the service network that is associated with the resource configuration.
status	string	The status of the association. (CREATE_IN_PROGRESS, ACTIVE, PARTIAL, DELETE_IN_PROGRESS, CREATE_FAILED, DELETE_FAILED)

list_service_network_resource_associations

Name	Datatype	Description
id	string	The ID of the association between the service network and resource configuration. (pattern: <code>snra-[0-9a-f]{17}</code>)
arn	string	The Amazon Resource Name (ARN) of the association. (pattern: <code>arn:[a-z0-9-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:servicenetworkresourceassociation/snra-[0-9a-f]{17}</code>)
created_at	string (date-time)	The date and time that the association was created, in ISO-8601 format.
created_by	string	The account that created the association. (pattern: <code>[0-9]{12}</code>)
dns_entry	object	The DNS entry for the service.
failure_code	string	The failure code.
is_managed_association	boolean	Specifies whether the association is managed by Amazon.
private_dns_enabled	boolean	Indicates if private DNS is enabled for the service network resource association.
private_dns_entry	object	The private DNS entry for the service.
resource_configuration_arn	string	The Amazon Resource Name (ARN) of the association. (pattern: <code>arn:[a-z0-9f-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}</code>)
resource_configuration_id	string	The ID of the resource configuration associated with the service network. (pattern: <code>rcfg-[0-9a-z]{17}</code>)
resource_configuration_name	string	The name of the resource configuration associated with the service network. (pattern: <code>(?!rcfg-)(?![-])(?!.[-]$)(?!.[-]{2})[a-z0-9-]+</code>)
service_network_arn	string	The Amazon Resource Name (ARN) of the service network associated with the resource configuration.
service_network_id	string	The ID of the service network associated with the resource configuration.
service_network_name	string	The name of the service network associated with the resource configuration.
status	string	The status of the service network’s association with the resource configuration. If the deletion fails, try to delete again. (CREATE_IN_PROGRESS, ACTIVE, PARTIAL, DELETE_IN_PROGRESS, CREATE_FAILED, DELETE_FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_network_resource_association	select	service_network_resource_association_identifier, region		Retrieves information about the specified association between a service network and a resource configuration.
list_service_network_resource_associations	select	region	serviceNetworkIdentifier, resourceConfigurationIdentifier, maxResults, nextToken, includeChildren	Lists the associations between a service network and a resource configuration.
create_service_network_resource_association	insert	region, resourceConfigurationIdentifier, serviceNetworkIdentifier		Associates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint.
delete_service_network_resource_association	delete	service_network_resource_association_identifier, region		Deletes the association between a service network and a 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)
service_network_resource_association_identifier	string	The ID of the association.
includeChildren	boolean	Include service network resource associations of the child resource configuration with the grouped resource configuration. The type is boolean and the default value is false.
maxResults	integer	The maximum page size.
nextToken	string	If there are additional results, a pagination token for the next page of results.
resourceConfigurationIdentifier	string	The ID of the resource configuration.
serviceNetworkIdentifier	string	The ID of the service network.

SELECT examples

get_service_network_resource_association

Retrieves information about the specified association between a service network and a resource configuration.

SELECT
id,
arn,
created_at,
created_by,
dns_entry,
domain_verification_status,
failure_code,
failure_reason,
is_managed_association,
last_updated_at,
private_dns_enabled,
private_dns_entry,
resource_configuration_arn,
resource_configuration_id,
resource_configuration_name,
service_network_arn,
service_network_id,
service_network_name,
status
FROM aws.vpc_lattice.service_network_resource_associations
WHERE service_network_resource_association_identifier = '{{ service_network_resource_association_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_service_network_resource_associations

Lists the associations between a service network and a resource configuration.

SELECT
id,
arn,
created_at,
created_by,
dns_entry,
failure_code,
is_managed_association,
private_dns_enabled,
private_dns_entry,
resource_configuration_arn,
resource_configuration_id,
resource_configuration_name,
service_network_arn,
service_network_id,
service_network_name,
status
FROM aws.vpc_lattice.service_network_resource_associations
WHERE region = '{{ region }}' -- required
AND serviceNetworkIdentifier = '{{ serviceNetworkIdentifier }}'
AND resourceConfigurationIdentifier = '{{ resourceConfigurationIdentifier }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND includeChildren = '{{ includeChildren }}'
;

INSERT examples

create_service_network_resource_association

Associates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint.

INSERT INTO aws.vpc_lattice.service_network_resource_associations (
clientToken,
resourceConfigurationIdentifier,
serviceNetworkIdentifier,
privateDnsEnabled,
tags,
region
)
SELECT 
'{{ clientToken }}',
'{{ resourceConfigurationIdentifier }}' /* required */,
'{{ serviceNetworkIdentifier }}' /* required */,
{{ privateDnsEnabled }},
'{{ tags }}',
'{{ region }}'
RETURNING
id,
arn,
created_by,
private_dns_enabled,
status
;

Manifest

# Description fields are for documentation purposes
- name: service_network_resource_associations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the service_network_resource_associations resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: resourceConfigurationIdentifier
    value: "{{ resourceConfigurationIdentifier }}"
  - name: serviceNetworkIdentifier
    value: "{{ serviceNetworkIdentifier }}"
  - name: privateDnsEnabled
    value: {{ privateDnsEnabled }}
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_service_network_resource_association

Deletes the association between a service network and a resource configuration.

DELETE FROM aws.vpc_lattice.service_network_resource_associations
WHERE service_network_resource_association_identifier = '{{ service_network_resource_association_identifier }}' --required
AND region = '{{ region }}' --required
;