metered_products

Creates, updates, deletes or gets a metered_product resource or lists metered_products in a region

Overview

Name	metered_products
Type	Resource
Description	Definition of AWS::Deadline::MeteredProduct Resource Type
Id	awscc.deadline.metered_products

Fields

get (all properties)

Name	Datatype	Description
license_endpoint_id	string
product_id	string
port	integer
family	string
vendor	string
arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	metered_products	INSERT	region
delete_resource	metered_products	DELETE	Identifier, region
list_resources	metered_products_list_only	SELECT	region
get_resource	metered_products	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual metered_product.

SELECT
  region,
  license_endpoint_id,
  product_id,
  port,
  family,
  vendor,
  arn
FROM awscc.deadline.metered_products
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all metered_products in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.deadline.metered_products (
  LicenseEndpointId,
  ProductId,
  region
)
SELECT
  '{{ license_endpoint_id }}',
  '{{ product_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.deadline.metered_products (
  LicenseEndpointId,
  ProductId,
  region
)
SELECT
  '{{ license_endpoint_id }}',
  '{{ product_id }}',
  '{{ 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: metered_product
  props:
    - name: license_endpoint_id
      value: '{{ license_endpoint_id }}'
    - name: product_id
      value: '{{ product_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.metered_products
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 metered_products resource, the following permissions are required:

Create

deadline:PutMeteredProduct,
deadline:ListMeteredProducts

Read

deadline:GetMeteredProduct,
deadline:ListMeteredProducts

Delete

deadline:DeleteMeteredProduct,
deadline:ListMeteredProducts

List

deadline:ListMeteredProducts