license_endpoints

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

Overview

Name	license_endpoints
Type	Resource
Id	aws.deadline.license_endpoints

Fields

The following fields are returned by SELECT queries:

get_license_endpoint

Name	Datatype	Description
dns_name	string	The DNS name.
license_endpoint_id	string	The license endpoint ID. (pattern: <code>le-[0-9a-f]{32}</code>)
security_group_ids	array	The security group IDs for the license endpoint.
status	string	The status of the license endpoint. (CREATE_IN_PROGRESS, DELETE_IN_PROGRESS, READY, NOT_READY)
status_message	string	The status message of the license endpoint.
subnet_ids	array	The subnet IDs.
vpc_id	string	The VPC (virtual private cloud) ID associated with the license endpoint. (pattern: <code>vpc-[\w]{1,120}</code>)

list_license_endpoints

Name	Datatype	Description
license_endpoint_id	string	The license endpoint ID. (pattern: <code>le-[0-9a-f]{32}</code>)
status	string	The status of the license endpoint. (CREATE_IN_PROGRESS, DELETE_IN_PROGRESS, READY, NOT_READY)
status_message	string	The status message of the license endpoint.
vpc_id	string	The VPC (virtual private cloud) ID associated with the license endpoint. (pattern: <code>vpc-[\w]{1,120}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_license_endpoint	select	license_endpoint_id, region		Gets a licence endpoint.
list_license_endpoints	select	region	nextToken, maxResults	Lists license endpoints.
create_license_endpoint	insert	region, vpcId, subnetIds, securityGroupIds	X-Amz-Client-Token	Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
delete_license_endpoint	delete	license_endpoint_id, region		Deletes a license 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
license_endpoint_id	string	The license endpoint ID of the license endpoint to delete.
region	string	AWS region (default: us-east-1)
X-Amz-Client-Token	string	The unique token which the server uses to recognize retries of the same request.
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.

SELECT examples

get_license_endpoint

Gets a licence endpoint.

SELECT
dns_name,
license_endpoint_id,
security_group_ids,
status,
status_message,
subnet_ids,
vpc_id
FROM aws.deadline.license_endpoints
WHERE license_endpoint_id = '{{ license_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
;

list_license_endpoints

Lists license endpoints.

SELECT
license_endpoint_id,
status,
status_message,
vpc_id
FROM aws.deadline.license_endpoints
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_license_endpoint

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

INSERT INTO aws.deadline.license_endpoints (
vpcId,
subnetIds,
securityGroupIds,
tags,
region,
`X-Amz-Client-Token`
)
SELECT 
'{{ vpcId }}' /* required */,
'{{ subnetIds }}' /* required */,
'{{ securityGroupIds }}' /* required */,
'{{ tags }}',
'{{ region }}',
'{{ X-Amz-Client-Token }}'
RETURNING
license_endpoint_id
;

Manifest

# Description fields are for documentation purposes
- name: license_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the license_endpoints resource.
  - name: vpcId
    value: "{{ vpcId }}"
  - name: subnetIds
    value:
      - "{{ subnetIds }}"
  - name: securityGroupIds
    value:
      - "{{ securityGroupIds }}"
  - name: tags
    value: "{{ tags }}"
  - name: X-Amz-Client-Token
    value: "{{ X-Amz-Client-Token }}"
    description: The unique token which the server uses to recognize retries of the same request.
    description: The unique token which the server uses to recognize retries of the same request.

DELETE examples

delete_license_endpoint

Deletes a license endpoint.

DELETE FROM aws.deadline.license_endpoints
WHERE license_endpoint_id = '{{ license_endpoint_id }}' --required
AND region = '{{ region }}' --required
;