resource_configurations

Creates, updates, deletes or gets a resource_configuration resource or lists resource_configurations in a region

Overview

Name	resource_configurations
Type	Resource
Description	VpcLattice ResourceConfiguration CFN resource
Id	aws.vpclattice.resource_configurations

Fields

Name	Datatype	Description
allow_association_to_sharable_service_network	boolean
protocol_type	string
resource_configuration_type	string
port_ranges	array
resource_configuration_definition	object
id	string
resource_gateway_id	string
arn	string
resource_configuration_auth_type	string
resource_configuration_group_id	string
tags	array
name	string
region	string	AWS region.

For more information, see AWS::VpcLattice::ResourceConfiguration.

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 resource_configurations in a region.

SELECT
region,
allow_association_to_sharable_service_network,
protocol_type,
resource_configuration_type,
port_ranges,
resource_configuration_definition,
id,
resource_gateway_id,
arn,
resource_configuration_auth_type,
resource_configuration_group_id,
tags,
name
FROM aws.vpclattice.resource_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual resource_configuration.

SELECT
region,
allow_association_to_sharable_service_network,
protocol_type,
resource_configuration_type,
port_ranges,
resource_configuration_definition,
id,
resource_gateway_id,
arn,
resource_configuration_auth_type,
resource_configuration_group_id,
tags,
name
FROM aws.vpclattice.resource_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.vpclattice.resource_configurations (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.vpclattice.resource_configurations (
 AllowAssociationToSharableServiceNetwork,
 ProtocolType,
 ResourceConfigurationType,
 PortRanges,
 ResourceConfigurationDefinition,
 ResourceGatewayId,
 ResourceConfigurationAuthType,
 ResourceConfigurationGroupId,
 Tags,
 Name,
 region
)
SELECT 
 '{{ AllowAssociationToSharableServiceNetwork }}',
 '{{ ProtocolType }}',
 '{{ ResourceConfigurationType }}',
 '{{ PortRanges }}',
 '{{ ResourceConfigurationDefinition }}',
 '{{ ResourceGatewayId }}',
 '{{ ResourceConfigurationAuthType }}',
 '{{ ResourceConfigurationGroupId }}',
 '{{ Tags }}',
 '{{ Name }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: resource_configuration
    props:
      - name: AllowAssociationToSharableServiceNetwork
        value: '{{ AllowAssociationToSharableServiceNetwork }}'
      - name: ProtocolType
        value: '{{ ProtocolType }}'
      - name: ResourceConfigurationType
        value: '{{ ResourceConfigurationType }}'
      - name: PortRanges
        value:
          - '{{ PortRanges[0] }}'
      - name: ResourceConfigurationDefinition
        value: {}
      - name: ResourceGatewayId
        value: '{{ ResourceGatewayId }}'
      - name: ResourceConfigurationAuthType
        value: '{{ ResourceConfigurationAuthType }}'
      - name: ResourceConfigurationGroupId
        value: '{{ ResourceConfigurationGroupId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Name
        value: '{{ Name }}'

DELETE example

/*+ delete */
DELETE FROM aws.vpclattice.resource_configurations
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Read

vpc-lattice:GetResourceConfiguration,
vpc-lattice:ListTagsForResource

Create

ec2:DescribeSubnets,
vpc-lattice:CreateResourceConfiguration,
vpc-lattice:GetResourceConfiguration,
vpc-lattice:TagResource,
vpc-lattice:ListTagsForResource

Update

ec2:DescribeSubnets,
vpc-lattice:TagResource,
vpc-lattice:UntagResource,
vpc-lattice:ListTagsForResource,
vpc-lattice:UpdateResourceConfiguration,
vpc-lattice:GetResourceConfiguration

List

vpc-lattice:ListResourceConfigurations

Delete

vpc-lattice:DeleteResourceConfiguration,
vpc-lattice:GetResourceConfiguration,
vpc-lattice:UntagResource