create_eks_anywhere_subscription
¶
create_eks_anywhere_subscription(
name: EksAnywhereSubscriptionName,
term: EksAnywhereSubscriptionTerm,
*,
config_overrides: Optional[EKSClientConfig] = None,
license_quantity: Optional[Integer] = None,
license_type: Optional[EksAnywhereSubscriptionLicenseType] = None,
auto_renew: Optional[Boolean] = None,
client_request_token: Optional[String] = None,
tags: Optional[TagMap] = None,
) -> CreateEksAnywhereSubscriptionResponse
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.
Parameters:
-
name(EksAnywhereSubscriptionName) –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(EksAnywhereSubscriptionTerm) –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.
-
license_quantity(Optional[Integer], default:None) –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.
-
license_type(Optional[EksAnywhereSubscriptionLicenseType], default:None) –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.
-
auto_renew(Optional[Boolean], default:None) –A boolean indicating whether the subscription auto renews at the end of the term.
-
client_request_token(Optional[String], default:None) –A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
tags(Optional[TagMap], default:None) –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.
Raises:
-
ClientException–These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
-
InvalidParameterException–The specified parameter is invalid. Review the available parameters for the API request.
-
ResourceLimitExceededException–You have encountered a service limit on the specified resource.
-
ServerException–These errors are usually caused by a server-side issue.
-
ServiceUnavailableException–The service is unavailable. Back off and retry the operation.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_eks/_services/eks.py
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 | |