eks_anywhere_subscriptions

Creates, updates, deletes, gets or lists an eks_anywhere_subscriptions resource.

Overview

Name	eks_anywhere_subscriptions
Type	Resource
Id	aws.eks.eks_anywhere_subscriptions

Fields

The following fields are returned by SELECT queries:

describe_eks_anywhere_subscription

Name	Datatype	Description
id	string	UUID identifying a subscription.
arn	string	The Amazon Resource Name (ARN) for the subscription.
auto_renew	boolean	A boolean indicating whether or not a subscription will auto renew when it expires.
created_at	string (date-time)	The Unix timestamp in seconds for when the subscription was created.
effective_date	string (date-time)	The Unix timestamp in seconds for when the subscription is effective.
expiration_date	string (date-time)	The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object.
license_arns	array	Amazon Web Services License Manager ARN associated with the subscription.
license_quantity	integer	The number of licenses included in a subscription. Valid values are between 1 and 100.
license_type	string	The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster. (Cluster)
licenses	array	Includes all of the claims in the license token necessary to validate the license for extended support.
status	string	The status of a subscription.
tags	object	The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription.
term	object	An object representing the term duration and term unit type of your subscription. This determines the term length of your subscription. Valid values are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month or 36 month subscription.

list_eks_anywhere_subscriptions

Name	Datatype	Description
id	string	UUID identifying a subscription.
arn	string	The Amazon Resource Name (ARN) for the subscription.
auto_renew	boolean	A boolean indicating whether or not a subscription will auto renew when it expires.
created_at	string (date-time)	The Unix timestamp in seconds for when the subscription was created.
effective_date	string (date-time)	The Unix timestamp in seconds for when the subscription is effective.
expiration_date	string (date-time)	The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object.
license_arns	array	Amazon Web Services License Manager ARN associated with the subscription.
license_quantity	integer	The number of licenses included in a subscription. Valid values are between 1 and 100.
license_type	string	The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster. (Cluster)
licenses	array	Includes all of the claims in the license token necessary to validate the license for extended support.
status	string	The status of a subscription.
tags	object	The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription.
term	object	An object representing the term duration and term unit type of your subscription. This determines the term length of your subscription. Valid values are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month or 36 month subscription.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_eks_anywhere_subscription	select	id, region		Returns descriptive information about a subscription.
list_eks_anywhere_subscriptions	select	region	maxResults, nextToken, includeStatus	Displays the full description of the subscription.
create_eks_anywhere_subscription	insert	region, name, term		Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.
update_eks_anywhere_subscription	update	id, region, autoRenew		Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.
delete_eks_anywhere_subscription	delete	id, region		Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating a ticket in the Amazon Web Services Support Center.

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
id	string	The ID of the subscription.
region	string	AWS region (default: us-east-1)
includeStatus	array	An array of subscription statuses to filter on.
maxResults	integer	The maximum number of cluster results returned by ListEksAnywhereSubscriptions in paginated output. When you use this parameter, ListEksAnywhereSubscriptions returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListEksAnywhereSubscriptions request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListEksAnywhereSubscriptions returns up to 10 results and a nextToken value if applicable.
nextToken	string	The nextToken value returned from a previous paginated ListEksAnywhereSubscriptions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

SELECT examples

describe_eks_anywhere_subscription

Returns descriptive information about a subscription.

SELECT
id,
arn,
auto_renew,
created_at,
effective_date,
expiration_date,
license_arns,
license_quantity,
license_type,
licenses,
status,
tags,
term
FROM aws.eks.eks_anywhere_subscriptions
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_eks_anywhere_subscriptions

Displays the full description of the subscription.

SELECT
id,
arn,
auto_renew,
created_at,
effective_date,
expiration_date,
license_arns,
license_quantity,
license_type,
licenses,
status,
tags,
term
FROM aws.eks.eks_anywhere_subscriptions
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND includeStatus = '{{ includeStatus }}'
;

INSERT examples

create_eks_anywhere_subscription

Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.

INSERT INTO aws.eks.eks_anywhere_subscriptions (
name,
term,
licenseQuantity,
licenseType,
autoRenew,
clientRequestToken,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ term }}' /* required */,
{{ licenseQuantity }},
'{{ licenseType }}',
{{ autoRenew }},
'{{ clientRequestToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
subscription
;

Manifest

# Description fields are for documentation purposes
- name: eks_anywhere_subscriptions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the eks_anywhere_subscriptions resource.
  - name: name
    value: "{{ name }}"
  - name: term
    description: |
      An object representing the term duration and term unit type of your subscription. This determines the term length of your subscription. Valid values are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month or 36 month subscription.
    value:
      duration: {{ duration }}
      unit: "{{ unit }}"
  - name: licenseQuantity
    value: {{ licenseQuantity }}
  - name: licenseType
    value: "{{ licenseType }}"
    valid_values: ['Cluster']
  - name: autoRenew
    value: {{ autoRenew }}
  - name: clientRequestToken
    value: "{{ clientRequestToken }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them. The following basic restrictions apply to tags: Maximum number of tags per resource – 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length – 128 Unicode characters in UTF-8 Maximum value length – 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

UPDATE examples

update_eks_anywhere_subscription

Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.

UPDATE aws.eks.eks_anywhere_subscriptions
SET 
autoRenew = {{ autoRenew }},
clientRequestToken = '{{ clientRequestToken }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND autoRenew = {{ autoRenew }} --required
RETURNING
subscription;

DELETE examples

delete_eks_anywhere_subscription

Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating a ticket in the Amazon Web Services Support Center.

DELETE FROM aws.eks.eks_anywhere_subscriptions
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;