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	awscc.deadline.license_endpoints

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	license_endpoints	INSERT	SecurityGroupIds, SubnetIds, VpcId, region
delete_resource	license_endpoints	DELETE	Identifier, region
update_resource	license_endpoints	UPDATE	Identifier, PatchDocument, region
list_resources	license_endpoints_list_only	SELECT	region
get_resource	license_endpoints	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.deadline.license_endpoints
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all license_endpoints in a region.

SELECT
  region,
  arn
FROM awscc.deadline.license_endpoints_list_only
WHERE
  region = '{{ region }}';

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 awscc.deadline.license_endpoints (
  SecurityGroupIds,
  SubnetIds,
  VpcId,
  region
)
SELECT
  '{{ security_group_ids }}',
  '{{ subnet_ids }}',
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.deadline.license_endpoints (
  SecurityGroupIds,
  SubnetIds,
  VpcId,
  Tags,
  region
)
SELECT
  '{{ security_group_ids }}',
  '{{ subnet_ids }}',
  '{{ vpc_id }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: license_endpoint
  props:
    - name: security_group_ids
      value:
        - '{{ security_group_ids[0] }}'
    - name: subnet_ids
      value:
        - '{{ subnet_ids[0] }}'
    - name: vpc_id
      value: '{{ vpc_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.deadline.license_endpoints
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.license_endpoints
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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