license_endpoints

Creates, updates, deletes or gets a license_endpoint resource or lists license_endpoints in a region

Overview

Name	license_endpoints
Type	Resource
Description	Definition of AWS::Deadline::LicenseEndpoint Resource Type
Id	aws.deadline.license_endpoints

Fields

Name	Datatype	Description
dns_name	string
license_endpoint_id	string
security_group_ids	array
status	string
status_message	string
subnet_ids	array
vpc_id	string
arn	string
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::Deadline::LicenseEndpoint.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SecurityGroupIds, SubnetIds, VpcId, 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 license_endpoints in a region.

SELECT
region,
dns_name,
license_endpoint_id,
security_group_ids,
status,
status_message,
subnet_ids,
vpc_id,
arn,
tags
FROM aws.deadline.license_endpoints
WHERE region = 'us-east-1';

Gets all properties from an individual license_endpoint.

SELECT
region,
dns_name,
license_endpoint_id,
security_group_ids,
status,
status_message,
subnet_ids,
vpc_id,
arn,
tags
FROM aws.deadline.license_endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.deadline.license_endpoints (
 SecurityGroupIds,
 SubnetIds,
 VpcId,
 region
)
SELECT 
'{{ SecurityGroupIds }}',
 '{{ SubnetIds }}',
 '{{ VpcId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.deadline.license_endpoints (
 SecurityGroupIds,
 SubnetIds,
 VpcId,
 Tags,
 region
)
SELECT 
 '{{ SecurityGroupIds }}',
 '{{ SubnetIds }}',
 '{{ VpcId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: license_endpoint
    props:
      - name: SecurityGroupIds
        value:
          - '{{ SecurityGroupIds[0] }}'
      - name: SubnetIds
        value:
          - '{{ SubnetIds[0] }}'
      - name: VpcId
        value: '{{ VpcId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

deadline:CreateLicenseEndpoint,
deadline:GetLicenseEndpoint,
ec2:CreateTags,
ec2:CreateVpcEndpoint,
ec2:DescribeVpcEndpoints,
deadline:TagResource,
deadline:ListTagsForResource

Read

deadline:GetLicenseEndpoint,
deadline:ListTagsForResource

Update

deadline:TagResource,
deadline:UntagResource,
deadline:ListTagsForResource,
deadline:GetLicenseEndpoint

Delete

deadline:GetLicenseEndpoint,
deadline:DeleteLicenseEndpoint,
ec2:DeleteVpcEndpoints,
ec2:DescribeVpcEndpoints

List

deadline:ListLicenseEndpoints