Create Eks Anywhere Subscription

eks_create_eks_anywhere_subscription

R Documentation

Creates an EKS Anywhere subscription

Description

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.

Usage

eks_create_eks_anywhere_subscription(name, term, licenseQuantity,
  licenseType, autoRenew, clientRequestToken, tags)

Arguments

name

[required] The unique name for your subscription. It must be unique in your Amazon Web Services account in the Amazon Web Services Region you're creating the subscription in. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphabetic character and can't be longer than 100 characters.

term

[required] 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. This value cannot be changed after creating the subscription.

licenseQuantity

The number of licenses to purchase with the subscription. Valid values are between 1 and 100. This value can't be changed after creating the subscription.

licenseType

The license type for all licenses in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

autoRenew

A boolean indicating whether the subscription auto renews at the end of the term.

clientRequestToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

tags

The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags don't propagate to any other resources associated with the subscription.

Value

A list with the following syntax:

list(
  subscription = list(
    id = "string",
    arn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    effectiveDate = as.POSIXct(
      "2015-01-01"
    ),
    expirationDate = as.POSIXct(
      "2015-01-01"
    ),
    licenseQuantity = 123,
    licenseType = "Cluster",
    term = list(
      duration = 123,
      unit = "MONTHS"
    ),
    status = "string",
    autoRenew = TRUE|FALSE,
    licenseArns = list(
      "string"
    ),
    tags = list(
      "string"
    )
  )
)

Request syntax

svc$create_eks_anywhere_subscription(
  name = "string",
  term = list(
    duration = 123,
    unit = "MONTHS"
  ),
  licenseQuantity = 123,
  licenseType = "Cluster",
  autoRenew = TRUE|FALSE,
  clientRequestToken = "string",
  tags = list(
    "string"
  )
)