vpce_configurations

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

Overview

Name	vpce_configurations
Type	Resource
Id	aws.devicefarm.vpce_configurations

Fields

The following fields are returned by SELECT queries:

get_vpce_configuration

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the VPC endpoint configuration. (pattern: <code>^arn:aws:devicefarm:.+</code>)
service_dns_name	string	The DNS name that maps to the private IP address of the service you want to access.
vpce_configuration_description	string	An optional description that provides details about your VPC endpoint configuration.
vpce_configuration_name	string	The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.
vpce_service_name	string	The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

list_vpce_configurations

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the VPC endpoint configuration. (pattern: <code>^arn:aws:devicefarm:.+</code>)
service_dns_name	string	The DNS name that maps to the private IP address of the service you want to access.
vpce_configuration_description	string	An optional description that provides details about your VPC endpoint configuration.
vpce_configuration_name	string	The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.
vpce_service_name	string	The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vpce_configuration	select	region		Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
list_vpce_configurations	select	region		Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
create_vpce_configuration	insert	region, vpceConfigurationName, vpceServiceName, serviceDnsName		Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
update_vpce_configuration	update	region, arn		Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
delete_vpce_configuration	delete	region		Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

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

get_vpce_configuration

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

SELECT
arn,
service_dns_name,
vpce_configuration_description,
vpce_configuration_name,
vpce_service_name
FROM aws.devicefarm.vpce_configurations
WHERE region = '{{ region }}' -- required
;

list_vpce_configurations

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

SELECT
arn,
service_dns_name,
vpce_configuration_description,
vpce_configuration_name,
vpce_service_name
FROM aws.devicefarm.vpce_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_vpce_configuration

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

INSERT INTO aws.devicefarm.vpce_configurations (
vpceConfigurationName,
vpceServiceName,
serviceDnsName,
vpceConfigurationDescription,
region
)
SELECT 
'{{ vpceConfigurationName }}' /* required */,
'{{ vpceServiceName }}' /* required */,
'{{ serviceDnsName }}' /* required */,
'{{ vpceConfigurationDescription }}',
'{{ region }}'
RETURNING
vpce_configuration
;

Manifest

# Description fields are for documentation purposes
- name: vpce_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpce_configurations resource.
  - name: vpceConfigurationName
    value: "{{ vpceConfigurationName }}"
    description: |
      The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
  - name: vpceServiceName
    value: "{{ vpceServiceName }}"
    description: |
      The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.
  - name: serviceDnsName
    value: "{{ serviceDnsName }}"
    description: |
      The DNS name of the service running in your VPC that you want Device Farm to test.
  - name: vpceConfigurationDescription
    value: "{{ vpceConfigurationDescription }}"
    description: |
      An optional description that provides details about your VPC endpoint configuration.

UPDATE examples

update_vpce_configuration

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

UPDATE aws.devicefarm.vpce_configurations
SET 
arn = '{{ arn }}',
vpceConfigurationName = '{{ vpceConfigurationName }}',
vpceServiceName = '{{ vpceServiceName }}',
serviceDnsName = '{{ serviceDnsName }}',
vpceConfigurationDescription = '{{ vpceConfigurationDescription }}'
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
vpce_configuration;

DELETE examples

delete_vpce_configuration

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

DELETE FROM aws.devicefarm.vpce_configurations
WHERE region = '{{ region }}' --required
;