AWS.Tools.EKS.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.EKS</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.EKS.AddEKSAccessPolicyCmdlet"> <summary> Associates an access policy and its scope to an access entry. For more information about associating access policies, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html">Associating and disassociating access policies to and from access entries</a> in the <i>Amazon EKS User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSAccessPolicyCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSAccessPolicyCmdlet.AccessScope_Namespace"> <summary> <para> <para>A Kubernetes <c>namespace</c> that an access policy is scoped to. A value is required if you specified <c>namespace</c> for <c>Type</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSAccessPolicyCmdlet.PolicyArn"> <summary> <para> <para>The ARN of the <c>AccessPolicy</c> that you're associating. For a list of ARNs, use <c>ListAccessPolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSAccessPolicyCmdlet.PrincipalArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM user or role for the <c>AccessEntry</c> that you're associating the access policy to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSAccessPolicyCmdlet.AccessScope_Type"> <summary> <para> <para>The scope type of an access policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSAccessPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.AssociateAccessPolicyResponse). Specifying the name of a property of type Amazon.EKS.Model.AssociateAccessPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSAccessPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalArn parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSAccessPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.AddEKSEncryptionConfigCmdlet"> <summary> Associates an encryption configuration to an existing cluster. <para> Use this API to enable encryption on existing clusters that don't already have encryption enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSEncryptionConfigCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSEncryptionConfigCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSEncryptionConfigCmdlet.EncryptionConfig"> <summary> <para> <para>The configuration you are using for encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSEncryptionConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Update'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.AssociateEncryptionConfigResponse). Specifying the name of a property of type Amazon.EKS.Model.AssociateEncryptionConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSEncryptionConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSEncryptionConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet"> <summary> Associates an identity provider configuration to a cluster. <para> If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes <c>Role</c> and <c>ClusterRole</c> objects, assign permissions to them, and then bind them to the identities using Kubernetes <c>RoleBinding</c> and <c>ClusterRoleBinding</c> objects. For more information see <a href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/">Using RBAC Authorization</a> in the Kubernetes documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Oidc_ClientId"> <summary> <para> <para>This is also known as <i>audience</i>. The ID for the client application that makes authentication requests to the OIDC identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Oidc_GroupsClaim"> <summary> <para> <para>The JWT claim that the provider uses to return your groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Oidc_GroupsPrefix"> <summary> <para> <para>The prefix that is prepended to group claims to prevent clashes with existing names (such as <c>system:</c> groups). For example, the value<c> oidc:</c> will create group names like <c>oidc:engineering</c> and <c>oidc:infra</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Oidc_IdentityProviderConfigName"> <summary> <para> <para>The name of the OIDC provider configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Oidc_IssuerUrl"> <summary> <para> <para>The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with <c>https://</c> and should correspond to the <c>iss</c> claim in the provider's OIDC ID tokens. Based on the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like <c>https://server.example.org</c> or <c>https://example.com</c>. This URL should point to the level below <c>.well-known/openid-configuration</c> and must be publicly accessible over the internet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Oidc_RequiredClaim"> <summary> <para> <para>The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html">Amazon EKS service quotas</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Tag"> <summary> <para> <para>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Oidc_UsernameClaim"> <summary> <para> <para>The JSON Web Token (JWT) claim to use as the username. The default is <c>sub</c>, which is expected to be a unique identifier of the end user. You can choose other claims, such as <c>email</c> or <c>name</c>, depending on the OIDC identity provider. Claims other than <c>email</c> are prefixed with the issuer URL to prevent naming clashes with other plug-ins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Oidc_UsernamePrefix"> <summary> <para> <para>The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and <c>username</c> is a value other than <c>email</c>, the prefix defaults to <c>issuerurl#</c>. You can use the value <c>-</c> to disable all prefixing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.AssociateIdentityProviderConfigResponse). Specifying the name of a property of type Amazon.EKS.Model.AssociateIdentityProviderConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSIdentityProviderConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.AddEKSResourceTagCmdlet"> <summary> Associates the specified tags to an Amazon EKS resource with the specified <c>resourceArn</c>. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to add tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSResourceTagCmdlet.Tag"> <summary> <para> <para>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.AddEKSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryCmdlet"> <summary> Describes an access entry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryCmdlet.PrincipalArn"> <summary> <para> <para>The ARN of the IAM principal for the <c>AccessEntry</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessEntry'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeAccessEntryResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeAccessEntryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalArn parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryListCmdlet"> <summary> Lists the access entries for your cluster.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryListCmdlet.AssociatedPolicyArn"> <summary> <para> <para>The ARN of an <c>AccessPolicy</c>. When you specify an access policy ARN, only the access entries associated to that access policy are returned. For a list of available policy ARNs, use <c>ListAccessPolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryListCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListAccessEntriesResponse). Specifying the name of a property of type Amazon.EKS.Model.ListAccessEntriesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessEntryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessPolicyListCmdlet"> <summary> Lists the available access policies.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessPolicyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessPolicyListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListAccessPoliciesResponse). Specifying the name of a property of type Amazon.EKS.Model.ListAccessPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAccessPolicyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonCmdlet"> <summary> Describes an Amazon EKS add-on. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonCmdlet.AddonName"> <summary> <para> <para>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html"><c>ListAddons</c></a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Addon'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeAddonResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeAddonResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AddonName parameter. The -PassThru parameter is deprecated, use -Select '^AddonName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonConfigurationCmdlet"> <summary> Returns configuration options. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonConfigurationCmdlet.AddonName"> <summary> <para> <para>The name of the add-on. The name must match one of the names returned by <c>DescribeAddonVersions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonConfigurationCmdlet.AddonVersion"> <summary> <para> <para>The version of the add-on. The version must match one of the versions returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html"><c>DescribeAddonVersions</c></a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeAddonConfigurationResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeAddonConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonListCmdlet"> <summary> Lists the installed add-ons.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonListCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Addons'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListAddonsResponse). Specifying the name of a property of type Amazon.EKS.Model.ListAddonsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet"> <summary> Describes the versions for an add-on. <para> Information such as the Kubernetes versions that you can use the add-on with, the <c>owner</c>, <c>publisher</c>, and the <c>type</c> of the add-on are returned. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet.AddonName"> <summary> <para> <para>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html"><c>ListAddons</c></a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet.KubernetesVersion"> <summary> <para> <para>The Kubernetes versions that you can use the add-on with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet.Owner"> <summary> <para> <para>The owner of the add-on. For valid <c>owners</c>, don't specify a value for this property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet.Publisher"> <summary> <para> <para>The publisher of the add-on. For valid <c>publishers</c>, don't specify a value for this property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet.Type"> <summary> <para> <para>The type of the add-on. For valid <c>types</c>, don't specify a value for this property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Addons'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeAddonVersionsResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeAddonVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAddonVersionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSAssociatedAccessPolicyListCmdlet"> <summary> Lists the access policies associated with an access entry.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAssociatedAccessPolicyListCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAssociatedAccessPolicyListCmdlet.PrincipalArn"> <summary> <para> <para>The ARN of the IAM principal for the <c>AccessEntry</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAssociatedAccessPolicyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAssociatedAccessPolicyListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAssociatedAccessPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListAssociatedAccessPoliciesResponse). Specifying the name of a property of type Amazon.EKS.Model.ListAssociatedAccessPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAssociatedAccessPolicyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalArn parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSAssociatedAccessPolicyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterCmdlet"> <summary> Describes an Amazon EKS cluster. <para> The API server endpoint and certificate authority data returned by this operation are required for <c>kubelet</c> and <c>kubectl</c> to communicate with your Kubernetes API server. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html">Creating or updating a <c>kubeconfig</c> file for an Amazon EKS cluster</a>. </para><note><para> The API server endpoint and certificate authority data aren't available until the cluster reaches the <c>ACTIVE</c> state. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterCmdlet.Name"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeClusterResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterListCmdlet"> <summary> Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterListCmdlet.Include"> <summary> <para> <para>Indicates whether external clusters are included in the returned list. Use '<c>all</c>' to return <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html">https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html</a>connected clusters, or blank to return only Amazon EKS clusters. '<c>all</c>' must be in lowercase otherwise an error occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Clusters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListClustersResponse). Specifying the name of a property of type Amazon.EKS.Model.ListClustersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSClusterListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionCmdlet"> <summary> Returns descriptive information about a subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionCmdlet.Id"> <summary> <para> <para>The ID of the subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Subscription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeEksAnywhereSubscriptionResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeEksAnywhereSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionListCmdlet"> <summary> Displays the full description of the subscription.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionListCmdlet.IncludeStatus"> <summary> <para> <para>An array of subscription statuses to filter on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionListCmdlet.MaxResult"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated <c>ListEksAnywhereSubscriptions</c> request where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Subscriptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListEksAnywhereSubscriptionsResponse). Specifying the name of a property of type Amazon.EKS.Model.ListEksAnywhereSubscriptionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSEksAnywhereSubscriptionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileCmdlet"> <summary> Describes an Fargate profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileCmdlet.FargateProfileName"> <summary> <para> <para>The name of the Fargate profile to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FargateProfile'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeFargateProfileResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeFargateProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FargateProfileName parameter. The -PassThru parameter is deprecated, use -Select '^FargateProfileName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileListCmdlet"> <summary> Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileListCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FargateProfileNames'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListFargateProfilesResponse). Specifying the name of a property of type Amazon.EKS.Model.ListFargateProfilesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSFargateProfileListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigCmdlet"> <summary> Describes an identity provider configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigCmdlet.IdentityProviderConfig_Name"> <summary> <para> <para>The name of the identity provider configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigCmdlet.IdentityProviderConfig_Type"> <summary> <para> <para>The type of the identity provider configuration. The only type available is <c>oidc</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityProviderConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeIdentityProviderConfigResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeIdentityProviderConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigListCmdlet"> <summary> Lists the identity provider configurations for your cluster.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigListCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityProviderConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListIdentityProviderConfigsResponse). Specifying the name of a property of type Amazon.EKS.Model.ListIdentityProviderConfigsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSIdentityProviderConfigListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightCmdlet"> <summary> Returns details about an insight that you specify using its ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster to describe the insight for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightCmdlet.Id"> <summary> <para> <para>The identity of the insight to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Insight'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeInsightResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeInsightResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet"> <summary> Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet.Filter_Category"> <summary> <para> <para>The categories to use to filter insights.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet.ClusterName"> <summary> <para> <para>The name of the Amazon EKS cluster associated with the insights.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet.Filter_KubernetesVersion"> <summary> <para> <para>The Kubernetes versions to use to filter the insights.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet.Filter_Status"> <summary> <para> <para>The statuses to use to filter the insights. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of identity provider configurations returned by <c>ListInsights</c> in paginated output. When you use this parameter, <c>ListInsights</c> returns only <c>maxResults</c> results in a single page along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another <c>ListInsights</c> request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, <c>ListInsights</c> returns up to 100 results and a <c>nextToken</c> value, if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated <c>ListInsights</c> request. When the results of a <c>ListInsights</c> request exceed <c>maxResults</c>, you can use this value to retrieve the next page of results. This value is <c>null</c> when there are no more results to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Insights'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListInsightsResponse). Specifying the name of a property of type Amazon.EKS.Model.ListInsightsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSInsightListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupCmdlet"> <summary> Describes a managed node group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupCmdlet.NodegroupName"> <summary> <para> <para>The name of the node group to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Nodegroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeNodegroupResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeNodegroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NodegroupName parameter. The -PassThru parameter is deprecated, use -Select '^NodegroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupListCmdlet"> <summary> Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupListCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Nodegroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListNodegroupsResponse). Specifying the name of a property of type Amazon.EKS.Model.ListNodegroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSNodegroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationCmdlet"> <summary> Returns descriptive information about an EKS Pod Identity association. <para> This action requires the ID of the association. You can get the ID from the response to the <c>CreatePodIdentityAssocation</c> for newly created associations. Or, you can list the IDs for associations with <c>ListPodIdentityAssociations</c> and filter the list by namespace or service account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationCmdlet.AssociationId"> <summary> <para> <para>The ID of the association that you want the description of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster that the association is in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Association'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribePodIdentityAssociationResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribePodIdentityAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationListCmdlet"> <summary> List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationListCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster that the associations are in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationListCmdlet.Namespace"> <summary> <para> <para>The name of the Kubernetes namespace inside the cluster that the associations are in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationListCmdlet.ServiceAccount"> <summary> <para> <para>The name of the Kubernetes service account that the associations use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of EKS Pod Identity association results returned by <c>ListPodIdentityAssociations</c> in paginated output. When you use this parameter, <c>ListPodIdentityAssociations</c> returns only <c>maxResults</c> results in a single page along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another <c>ListPodIdentityAssociations</c> request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, <c>ListPodIdentityAssociations</c> returns up to 100 results and a <c>nextToken</c> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated <c>ListUpdates</c> request where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Associations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListPodIdentityAssociationsResponse). Specifying the name of a property of type Amazon.EKS.Model.ListPodIdentityAssociationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSPodIdentityAssociationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSResourceTagCmdlet"> <summary> List the tags for an Amazon EKS resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the resource to list tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.EKS.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateCmdlet"> <summary> Describes an update to an Amazon EKS resource. <para> When the status of the update is <c>Succeeded</c>, the update is complete. If an update fails, the status is <c>Failed</c>, and an error detail explains the reason for the failure. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateCmdlet.AddonName"> <summary> <para> <para>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html"><c>ListAddons</c></a>. This parameter is required if the update is an add-on update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateCmdlet.Name"> <summary> <para> <para>The name of the Amazon EKS cluster associated with the update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateCmdlet.NodegroupName"> <summary> <para> <para>The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateCmdlet.UpdateId"> <summary> <para> <para>The ID of the update to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Update'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeUpdateResponse). Specifying the name of a property of type Amazon.EKS.Model.DescribeUpdateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UpdateId parameter. The -PassThru parameter is deprecated, use -Select '^UpdateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateListCmdlet"> <summary> Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateListCmdlet.AddonName"> <summary> <para> <para>The names of the installed add-ons that have available updates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateListCmdlet.Name"> <summary> <para> <para>The name of the Amazon EKS cluster to list updates for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateListCmdlet.NodegroupName"> <summary> <para> <para>The name of the Amazon EKS managed node group to list updates for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results, returned in paginated output. You receive <c>maxResults</c> in a single page, along with a <c>nextToken</c> response element. You can see the remaining results of the initial request by sending another request with the returned <c>nextToken</c> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <c>nextToken</c> value, if applicable, are returned.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated request, where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. This value is null when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UpdateIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.ListUpdatesResponse). Specifying the name of a property of type Amazon.EKS.Model.ListUpdatesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.GetEKSUpdateListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet"> <summary> Creates an access entry. <para> An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the <c>aws-auth</c><c>ConfigMap</c> for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes <c>Role</c>, <c>ClusterRole</c>, <c>RoleBinding</c>, and <c>ClusterRoleBinding</c> objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage Kubernetes <c>Role</c>, <c>ClusterRole</c>, <c>RoleBinding</c>, and <c>ClusterRoleBinding</c> objects. </para><para> For more information about access entries, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html">Access entries</a> in the <i>Amazon EKS User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.KubernetesGroup"> <summary> <para> <para>The value for <c>name</c> that you've specified for <c>kind: Group</c> as a <c>subject</c> in a Kubernetes <c>RoleBinding</c> or <c>ClusterRoleBinding</c> object. Amazon EKS doesn't confirm that the value for <c>name</c> exists in any bindings on your cluster. You can specify one or more names.</para><para>Kubernetes authorizes the <c>principalArn</c> of the access entry to access any cluster objects that you've specified in a Kubernetes <c>Role</c> or <c>ClusterRole</c> object that is also specified in a binding's <c>roleRef</c>. For more information about creating Kubernetes <c>RoleBinding</c>, <c>ClusterRoleBinding</c>, <c>Role</c>, or <c>ClusterRole</c> objects, see <a href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/">Using RBAC Authorization in the Kubernetes documentation</a>.</para><para>If you want Amazon EKS to authorize the <c>principalArn</c> (instead of, or in addition to Kubernetes authorizing the <c>principalArn</c>), you can associate one or more access policies to the access entry using <c>AssociateAccessPolicy</c>. If you associate any access policies, the <c>principalARN</c> has all permissions assigned in the associated access policies and all permissions in any Kubernetes <c>Role</c> or <c>ClusterRole</c> objects that the group names are bound to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.PrincipalArn"> <summary> <para> <para>The ARN of the IAM principal for the <c>AccessEntry</c>. You can specify one ARN for each access entry. You can't specify the same ARN in more than one access entry. This value can't be changed after access entry creation.</para><para>The valid principals differ depending on the type of the access entry in the <c>type</c> field. The only valid ARN is IAM roles for the types of access entries for nodes: <code /><code />. You can use every IAM principal type for <c>STANDARD</c> access entries. You can't use the STS session principal type with access entries because this is a temporary principal for each session and not a permanent identity that can be assigned permissions.</para><para><a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-users-federation-idp">IAM best practices</a> recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.Tag"> <summary> <para> <para>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.Type"> <summary> <para> <para>The type of the new access entry. Valid values are <c>Standard</c>, <c>FARGATE_LINUX</c>, <c>EC2_LINUX</c>, and <c>EC2_WINDOWS</c>.</para><para>If the <c>principalArn</c> is for an IAM role that's used for self-managed Amazon EC2 nodes, specify <c>EC2_LINUX</c> or <c>EC2_WINDOWS</c>. Amazon EKS grants the necessary permissions to the node for you. If the <c>principalArn</c> is for any other purpose, specify <c>STANDARD</c>. If you don't specify a value, Amazon EKS sets the value to <c>STANDARD</c>. It's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the <c>aws-auth</c><c>ConfigMap</c> for the roles. You can't change this value once you've created the access entry.</para><para>If you set the value to <c>EC2_LINUX</c> or <c>EC2_WINDOWS</c>, you can't specify values for <c>kubernetesGroups</c>, or associate an <c>AccessPolicy</c> to the access entry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.Username"> <summary> <para> <para>The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries">Creating access entries</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessEntry'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.CreateAccessEntryResponse). Specifying the name of a property of type Amazon.EKS.Model.CreateAccessEntryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAccessEntryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet"> <summary> Creates an Amazon EKS add-on. <para> Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html">Amazon EKS add-ons</a> in the <i>Amazon EKS User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.AddonName"> <summary> <para> <para>The name of the add-on. The name must match one of the names returned by <c>DescribeAddonVersions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.AddonVersion"> <summary> <para> <para>The version of the add-on. The version must match one of the versions returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html"><c>DescribeAddonVersions</c></a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.ConfigurationValue"> <summary> <para> <para>The set of configuration values for the add-on that's created. The values that you provide are validated against the schema returned by <c>DescribeAddonConfiguration</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.ResolveConflict"> <summary> <para> <para>How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose:</para><ul><li><para><b>None</b> – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.</para></li><li><para><b>Overwrite</b> – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.</para></li><li><para><b>Preserve</b> – This is similar to the NONE option. If the self-managed version of the add-on is installed on your cluster Amazon EKS doesn't change the add-on resource properties. Creation of the add-on might fail if conflicts are detected. This option works differently during the update operation. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html">UpdateAddon</a>.</para></li></ul><para>If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.ServiceAccountRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html">Amazon EKS node IAM role</a> in the <i>Amazon EKS User Guide</i>.</para><note><para>To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html">Enabling IAM roles for service accounts on your cluster</a> in the <i>Amazon EKS User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.Tag"> <summary> <para> <para>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Addon'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.CreateAddonResponse). Specifying the name of a property of type Amazon.EKS.Model.CreateAddonResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AddonName parameter. The -PassThru parameter is deprecated, use -Select '^AddonName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSAddonCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet"> <summary> Creates an Amazon EKS control plane. <para> The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as <c>etcd</c> and the API server. The control plane runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances. </para><para> The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support <c>kubectl exec</c>, <c>logs</c>, and <c>proxy</c> data flows). </para><para> Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster. </para><para> You can use the <c>endpointPublicAccess</c> and <c>endpointPrivateAccess</c> parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html">Amazon EKS Cluster Endpoint Access Control</a> in the <i><i>Amazon EKS User Guide</i></i>. </para><para> You can use the <c>logging</c> parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html">Amazon EKS Cluster Control Plane Logs</a> in the <i><i>Amazon EKS User Guide</i></i>. </para><note><para> CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see <a href="http://aws.amazon.com/cloudwatch/pricing/">CloudWatch Pricing</a>. </para></note><para> In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html">Managing Cluster Authentication</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html">Launching Amazon EKS nodes</a> in the <i>Amazon EKS User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.AccessConfig_AuthenticationMode"> <summary> <para> <para>The desired authentication mode for the cluster. If you create a cluster by using the EKS API, Amazon Web Services SDKs, or CloudFormation, the default is <c>CONFIG_MAP</c>. If you create the cluster by using the Amazon Web Services Management Console, the default value is <c>API_AND_CONFIG_MAP</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.AccessConfig_BootstrapClusterCreatorAdminPermission"> <summary> <para> <para>Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time. The default value is <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.Logging_ClusterLogging"> <summary> <para> <para>The cluster control plane logging configuration for your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.OutpostConfig_ControlPlaneInstanceType"> <summary> <para> <para>The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes that your cluster will have. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html">Capacity considerations</a> in the <i>Amazon EKS User Guide</i>.</para><para>The instance type that you specify is used for all Kubernetes control plane instances. The instance type can't be changed after cluster creation. The control plane is not automatically scaled by Amazon EKS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.EncryptionConfig"> <summary> <para> <para>The encryption configuration for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.ControlPlanePlacement_GroupName"> <summary> <para> <para>The name of the placement group for the Kubernetes control plane instances. This setting can't be changed after cluster creation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.KubernetesNetworkConfig_IpFamily"> <summary> <para> <para>Specify which IP family is used to assign Kubernetes pod and service IP addresses. If you don't specify a value, <c>ipv4</c> is used by default. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created. If you specify <c>ipv6</c>, the VPC and subnets that you specify for cluster creation must have both <c>IPv4</c> and <c>IPv6</c> CIDR blocks assigned to them. You can't specify <c>ipv6</c> for clusters in China Regions.</para><para>You can only specify <c>ipv6</c> for <c>1.21</c> and later clusters that use version <c>1.10.1</c> or later of the Amazon VPC CNI add-on. If you specify <c>ipv6</c>, then ensure that your VPC meets the requirements listed in the considerations listed in <a href="https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html">Assigning IPv6 addresses to pods and services</a> in the Amazon EKS User Guide. Kubernetes assigns services <c>IPv6</c> addresses from the unique local address range <c>(fc00::/7)</c>. You can't specify a custom <c>IPv6</c> CIDR block. Pod addresses are assigned from the subnet's <c>IPv6</c> CIDR.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.Name"> <summary> <para> <para>The unique name to give to your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.OutpostConfig_OutpostArn"> <summary> <para> <para>The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts. Only a single Outpost ARN is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.ResourcesVpcConfig"> <summary> <para> <para>The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html">Cluster VPC Considerations</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html">Cluster Security Group Considerations</a> in the <i>Amazon EKS User Guide</i>. You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html">Amazon EKS Service IAM Role</a> in the <i><i>Amazon EKS User Guide</i></i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.KubernetesNetworkConfig_ServiceIpv4Cidr"> <summary> <para> <para>Don't specify a value if you select <c>ipv6</c> for <b>ipFamily</b>. The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the <c>10.100.0.0/16</c> or <c>172.20.0.0/16</c> CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. The block must meet the following requirements:</para><ul><li><para>Within one of the following private IP address blocks: <c>10.0.0.0/8</c>, <c>172.16.0.0/12</c>, or <c>192.168.0.0/16</c>.</para></li><li><para>Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC.</para></li><li><para>Between <c>/24</c> and <c>/12</c>.</para></li></ul><important><para>You can only specify a custom CIDR block when you create a cluster. You can't change this value after the cluster is created.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.Tag"> <summary> <para> <para>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.Version"> <summary> <para> <para>The desired Kubernetes version for your cluster. If you don't specify a value here, the default version available in Amazon EKS is used.</para><note><para>The default version might not be the latest version available.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.EKS.Model.CreateClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSClusterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.AutoRenew"> <summary> <para> <para>A boolean indicating whether the subscription auto renews at the end of the term.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.Term_Duration"> <summary> <para> <para>The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.LicenseQuantity"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.LicenseType"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.Name"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.Tag"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.Term_Unit"> <summary> <para> <para>The term unit of the subscription. Valid value is <c>MONTHS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Subscription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.CreateEksAnywhereSubscriptionResponse). Specifying the name of a property of type Amazon.EKS.Model.CreateEksAnywhereSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSEksAnywhereSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet"> <summary> Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate. <para> The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate. </para><para> When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes <a href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/">Role Based Access Control</a> (RBAC) for authorization so that the <c>kubelet</c> that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html">Pod Execution Role</a> in the <i>Amazon EKS User Guide</i>. </para><para> Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating. </para><para> If any Fargate profiles in a cluster are in the <c>DELETING</c> status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster. </para><para> For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html">Fargate profile</a> in the <i>Amazon EKS User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.FargateProfileName"> <summary> <para> <para>The name of the Fargate profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.PodExecutionRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the <c>Pod</c> execution role to use for a <c>Pod</c> that matches the selectors in the Fargate profile. The <c>Pod</c> execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html"><c>Pod</c> execution role</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.Selector"> <summary> <para> <para>The selectors to match for a <c>Pod</c> to use this Fargate profile. Each selector must have an associated Kubernetes <c>namespace</c>. Optionally, you can also specify <c>labels</c> for a <c>namespace</c>. You may specify up to five selectors in a Fargate profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.Subnet"> <summary> <para> <para>The IDs of subnets to launch a <c>Pod</c> into. A <c>Pod</c> running on Fargate isn't assigned a public IP address, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.Tag"> <summary> <para> <para>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FargateProfile'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.CreateFargateProfileResponse). Specifying the name of a property of type Amazon.EKS.Model.CreateFargateProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FargateProfileName parameter. The -PassThru parameter is deprecated, use -Select '^FargateProfileName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSFargateProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet"> <summary> Creates a managed node group for an Amazon EKS cluster. <para> You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a>. </para><para> An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html">Managed node groups</a> in the <i>Amazon EKS User Guide</i>. </para><note><para> Windows AMI types are only supported for commercial Amazon Web Services Regions that support Windows on Amazon EKS. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.AmiType"> <summary> <para> <para>The AMI type for your node group. If you specify <c>launchTemplate</c>, and your launch template uses a custom AMI, then don't specify <c>amiType</c>, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add <c>eks:kube-proxy-windows</c> to your Windows nodes <c>rolearn</c> in the <c>aws-auth</c><c>ConfigMap</c>. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.CapacityType"> <summary> <para> <para>The capacity type for your node group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.ScalingConfig_DesiredSize"> <summary> <para> <para>The current number of nodes that the managed node group should maintain.</para><important><para>If you use the Kubernetes <a href="https://github.com/kubernetes/autoscaler#kubernetes-autoscaler">Cluster Autoscaler</a>, you shouldn't change the <c>desiredSize</c> value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.</para></important><para>Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.</para><para>This parameter can be different from <c>minSize</c> in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the <c>desiredSize</c> parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than <c>minSize</c> or higher than <c>maxSize</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.DiskSize"> <summary> <para> <para>The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify <c>launchTemplate</c>, then don't specify <c>diskSize</c>, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.RemoteAccess_Ec2SshKey"> <summary> <para> <para>The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs and Linux instances</a> in the <i>Amazon Elastic Compute Cloud User Guide for Linux Instances</i>. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html">Amazon EC2 key pairs and Windows instances</a> in the <i>Amazon Elastic Compute Cloud User Guide for Windows Instances</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.LaunchTemplate_Id"> <summary> <para> <para>The ID of the launch template.</para><para>You must specify either the launch template ID or the launch template name in the request, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.InstanceType"> <summary> <para> <para>Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the <c>amiType</c> parameter. If you specify <c>launchTemplate</c>, then you can specify zero or one instance type in your launch template <i>or</i> you can specify 0-20 instance types for <c>instanceTypes</c>. If however, you specify an instance type in your launch template <i>and</i> specify any <c>instanceTypes</c>, the node group deployment will fail. If you don't specify an instance type in a launch template or for <c>instanceTypes</c>, then <c>t3.medium</c> is used, by default. If you specify <c>Spot</c> for <c>capacityType</c>, then we recommend specifying multiple values for <c>instanceTypes</c>. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types">Managed node group capacity types</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.Label"> <summary> <para> <para>The Kubernetes <c>labels</c> to apply to the nodes in the node group when they are created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.ScalingConfig_MaxSize"> <summary> <para> <para>The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html">Amazon EKS service quotas</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.UpdateConfig_MaxUnavailable"> <summary> <para> <para>The maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or <c>maxUnavailablePercentage</c> is required to have a value.The maximum number is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.UpdateConfig_MaxUnavailablePercentage"> <summary> <para> <para>The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or <c>maxUnavailable</c> is required to have a value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.ScalingConfig_MinSize"> <summary> <para> <para>The minimum number of nodes that the managed node group can scale in to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.LaunchTemplate_Name"> <summary> <para> <para>The name of the launch template.</para><para>You must specify either the launch template name or the launch template ID in the request, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.NodegroupName"> <summary> <para> <para>The unique name to give your node group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.NodeRole"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node <c>kubelet</c> daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html">Amazon EKS node IAM role</a> in the <i><i>Amazon EKS User Guide</i></i>. If you specify <c>launchTemplate</c>, then don't specify <c><a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html">IamInstanceProfile</a></c> in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.ReleaseVersion"> <summary> <para> <para>The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For information about Linux versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html">Amazon EKS optimized Amazon Linux AMI versions</a> in the <i>Amazon EKS User Guide</i>. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html">Amazon EKS optimized Windows AMI versions</a> in the <i>Amazon EKS User Guide</i>.</para><para>If you specify <c>launchTemplate</c>, and your launch template uses a custom AMI, then don't specify <c>releaseVersion</c>, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.RemoteAccess_SourceSecurityGroup"> <summary> <para> <para>The security group IDs that are allowed SSH access (port 22) to the nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet (<c>0.0.0.0/0</c>). For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.Subnet"> <summary> <para> <para>The subnets to use for the Auto Scaling group that is created for your node group. If you specify <c>launchTemplate</c>, then don't specify <c><a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html">SubnetId</a></c> in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.Tag"> <summary> <para> <para>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.Taint"> <summary> <para> <para>The Kubernetes taints to be applied to the nodes in the node group. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html">Node taints on managed node groups</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.LaunchTemplate_Version"> <summary> <para> <para>The version number of the launch template to use. If no version is specified, then the template's default version is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.Version"> <summary> <para> <para>The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify <c>launchTemplate</c>, and your launch template uses a custom AMI, then don't specify <c>version</c>, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Nodegroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.CreateNodegroupResponse). Specifying the name of a property of type Amazon.EKS.Model.CreateNodegroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NodegroupName parameter. The -PassThru parameter is deprecated, use -Select '^NodegroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSNodegroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet"> <summary> Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with <i>EKS Pod Identity</i>. Use EKS Pod Identity to give temporary IAM credentials to pods and the credentials are rotated automatically. <para> Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances. </para><para> If a pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the pod. The environment variables configure the Amazon Web Services SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials. </para><para> Pod Identity is a simpler method than <i>IAM roles for service accounts</i>, as this method doesn't use OIDC identity providers. Additionally, you can configure a role for Pod Identity once, and reuse it across clusters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster to create the association in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet.Namespace"> <summary> <para> <para>The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the pods that use the service account must be in this namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the pods that use this service account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet.ServiceAccount"> <summary> <para> <para>The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet.Tag"> <summary> <para> <para>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</para><para>The following basic restrictions apply to tags:</para><ul><li><para>Maximum number of tags per resource – 50</para></li><li><para>For each resource, each tag key must be unique, and each tag key can have only one value.</para></li><li><para>Maximum key length – 128 Unicode characters in UTF-8</para></li><li><para>Maximum value length – 256 Unicode characters in UTF-8</para></li><li><para>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: + - = . _ : / @.</para></li><li><para>Tag keys and values are case-sensitive.</para></li><li><para>Do not use <c>aws:</c>, <c>AWS:</c>, 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.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Association'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.CreatePodIdentityAssociationResponse). Specifying the name of a property of type Amazon.EKS.Model.CreatePodIdentityAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.NewEKSPodIdentityAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RegisterEKSClusterCmdlet"> <summary> Connects a Kubernetes cluster to the Amazon EKS control plane. <para> Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes. </para><para> Cluster connection requires two steps. First, send a <c><a>RegisterClusterRequest</a></c> to add it to the Amazon EKS control plane. </para><para> Second, a <a href="https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml">Manifest</a> containing the <c>activationID</c> and <c>activationCode</c> must be applied to the Kubernetes cluster through it's native provider to provide visibility. </para><para> After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using <c>DeregisterCluster</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RegisterEKSClusterCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RegisterEKSClusterCmdlet.Name"> <summary> <para> <para>A unique name for this cluster in your Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RegisterEKSClusterCmdlet.ConnectorConfig_Provider"> <summary> <para> <para>The cloud provider for the target cluster to connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RegisterEKSClusterCmdlet.ConnectorConfig_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the role that is authorized to request the connector configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RegisterEKSClusterCmdlet.Tag"> <summary> <para> <para>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RegisterEKSClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.RegisterClusterResponse). Specifying the name of a property of type Amazon.EKS.Model.RegisterClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RegisterEKSClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RegisterEKSClusterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessEntryCmdlet"> <summary> Deletes an access entry. <para> Deleting an access entry of a type other than <c>Standard</c> can cause your cluster to function improperly. If you delete an access entry in error, you can recreate it. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessEntryCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessEntryCmdlet.PrincipalArn"> <summary> <para> <para>The ARN of the IAM principal for the <c>AccessEntry</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessEntryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DeleteAccessEntryResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessEntryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalArn parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessEntryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessPolicyCmdlet"> <summary> Disassociates an access policy from an access entry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessPolicyCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessPolicyCmdlet.PolicyArn"> <summary> <para> <para>The ARN of the policy to disassociate from the access entry. For a list of associated policies ARNs, use <c>ListAssociatedAccessPolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessPolicyCmdlet.PrincipalArn"> <summary> <para> <para>The ARN of the IAM principal for the <c>AccessEntry</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DisassociateAccessPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalArn parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAccessPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAddonCmdlet"> <summary> Deletes an Amazon EKS add-on. <para> When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAddonCmdlet.AddonName"> <summary> <para> <para>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html"><c>ListAddons</c></a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAddonCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAddonCmdlet.Preserve"> <summary> <para> <para>Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it isn't removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAddonCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Addon'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DeleteAddonResponse). Specifying the name of a property of type Amazon.EKS.Model.DeleteAddonResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAddonCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AddonName parameter. The -PassThru parameter is deprecated, use -Select '^AddonName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSAddonCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSClusterCmdlet"> <summary> Deletes an Amazon EKS cluster control plane. <para> If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html">Deleting a cluster</a> in the <i>Amazon EKS User Guide</i>. </para><para> If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see <c>DeleteNodgroup</c> and <c>DeleteFargateProfile</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSClusterCmdlet.Name"> <summary> <para> <para>The name of the cluster to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DeleteClusterResponse). Specifying the name of a property of type Amazon.EKS.Model.DeleteClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSClusterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSEksAnywhereSubscriptionCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSEksAnywhereSubscriptionCmdlet.Id"> <summary> <para> <para>The ID of the subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSEksAnywhereSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Subscription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DeleteEksAnywhereSubscriptionResponse). Specifying the name of a property of type Amazon.EKS.Model.DeleteEksAnywhereSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSEksAnywhereSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSEksAnywhereSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSFargateProfileCmdlet"> <summary> Deletes an Fargate profile. <para> When you delete a Fargate profile, any <c>Pod</c> running on Fargate that was created with the profile is deleted. If the <c>Pod</c> matches another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and may remain in a pending state. </para><para> Only one Fargate profile in a cluster can be in the <c>DELETING</c> status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSFargateProfileCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSFargateProfileCmdlet.FargateProfileName"> <summary> <para> <para>The name of the Fargate profile to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSFargateProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FargateProfile'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DeleteFargateProfileResponse). Specifying the name of a property of type Amazon.EKS.Model.DeleteFargateProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSFargateProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FargateProfileName parameter. The -PassThru parameter is deprecated, use -Select '^FargateProfileName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSFargateProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSIdentityProviderConfigCmdlet"> <summary> Disassociates an identity provider configuration from a cluster. <para> If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with IAM principals. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSIdentityProviderConfigCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSIdentityProviderConfigCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSIdentityProviderConfigCmdlet.IdentityProviderConfig_Name"> <summary> <para> <para>The name of the identity provider configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSIdentityProviderConfigCmdlet.IdentityProviderConfig_Type"> <summary> <para> <para>The type of the identity provider configuration. The only type available is <c>oidc</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSIdentityProviderConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Update'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DisassociateIdentityProviderConfigResponse). Specifying the name of a property of type Amazon.EKS.Model.DisassociateIdentityProviderConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSIdentityProviderConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSIdentityProviderConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSNodegroupCmdlet"> <summary> Deletes a managed node group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSNodegroupCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSNodegroupCmdlet.NodegroupName"> <summary> <para> <para>The name of the node group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSNodegroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Nodegroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DeleteNodegroupResponse). Specifying the name of a property of type Amazon.EKS.Model.DeleteNodegroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSNodegroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NodegroupName parameter. The -PassThru parameter is deprecated, use -Select '^NodegroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSNodegroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSPodIdentityAssociationCmdlet"> <summary> Deletes a EKS Pod Identity association. <para> The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSPodIdentityAssociationCmdlet.AssociationId"> <summary> <para> <para>The ID of the association to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSPodIdentityAssociationCmdlet.ClusterName"> <summary> <para> <para>The cluster name that</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSPodIdentityAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Association'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DeletePodIdentityAssociationResponse). Specifying the name of a property of type Amazon.EKS.Model.DeletePodIdentityAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSPodIdentityAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSPodIdentityAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSResourceTagCmdlet"> <summary> Deletes specified tags from an Amazon EKS resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to delete tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.RemoveEKSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.UnregisterEKSClusterCmdlet"> <summary> Deregisters a connected cluster to remove it from the Amazon EKS control plane. <para> A connected cluster is a Kubernetes cluster that you've connected to your control plane using the <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html">Amazon EKS Connector</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UnregisterEKSClusterCmdlet.Name"> <summary> <para> <para>The name of the connected cluster to deregister.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UnregisterEKSClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DeregisterClusterResponse). Specifying the name of a property of type Amazon.EKS.Model.DeregisterClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UnregisterEKSClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UnregisterEKSClusterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAccessEntryCmdlet"> <summary> Updates an access entry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAccessEntryCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAccessEntryCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAccessEntryCmdlet.KubernetesGroup"> <summary> <para> <para>The value for <c>name</c> that you've specified for <c>kind: Group</c> as a <c>subject</c> in a Kubernetes <c>RoleBinding</c> or <c>ClusterRoleBinding</c> object. Amazon EKS doesn't confirm that the value for <c>name</c> exists in any bindings on your cluster. You can specify one or more names.</para><para>Kubernetes authorizes the <c>principalArn</c> of the access entry to access any cluster objects that you've specified in a Kubernetes <c>Role</c> or <c>ClusterRole</c> object that is also specified in a binding's <c>roleRef</c>. For more information about creating Kubernetes <c>RoleBinding</c>, <c>ClusterRoleBinding</c>, <c>Role</c>, or <c>ClusterRole</c> objects, see <a href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/">Using RBAC Authorization in the Kubernetes documentation</a>.</para><para>If you want Amazon EKS to authorize the <c>principalArn</c> (instead of, or in addition to Kubernetes authorizing the <c>principalArn</c>), you can associate one or more access policies to the access entry using <c>AssociateAccessPolicy</c>. If you associate any access policies, the <c>principalARN</c> has all permissions assigned in the associated access policies and all permissions in any Kubernetes <c>Role</c> or <c>ClusterRole</c> objects that the group names are bound to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAccessEntryCmdlet.PrincipalArn"> <summary> <para> <para>The ARN of the IAM principal for the <c>AccessEntry</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAccessEntryCmdlet.Username"> <summary> <para> <para>The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries">Creating access entries</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAccessEntryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessEntry'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.UpdateAccessEntryResponse). Specifying the name of a property of type Amazon.EKS.Model.UpdateAccessEntryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAccessEntryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalArn parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAccessEntryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet"> <summary> Updates an Amazon EKS add-on. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.AddonName"> <summary> <para> <para>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html"><c>ListAddons</c></a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.AddonVersion"> <summary> <para> <para>The version of the add-on. The version must match one of the versions returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html"><c>DescribeAddonVersions</c></a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.ConfigurationValue"> <summary> <para> <para>The set of configuration values for the add-on that's created. The values that you provide are validated against the schema returned by <c>DescribeAddonConfiguration</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.ResolveConflict"> <summary> <para> <para>How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:</para><ul><li><para><b>None</b> – Amazon EKS doesn't change the value. The update might fail.</para></li><li><para><b>Overwrite</b> – Amazon EKS overwrites the changed value back to the Amazon EKS default value.</para></li><li><para><b>Preserve</b> – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.ServiceAccountRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html">Amazon EKS node IAM role</a> in the <i>Amazon EKS User Guide</i>.</para><note><para>To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html">Enabling IAM roles for service accounts on your cluster</a> in the <i>Amazon EKS User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Update'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.UpdateAddonResponse). Specifying the name of a property of type Amazon.EKS.Model.UpdateAddonResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AddonName parameter. The -PassThru parameter is deprecated, use -Select '^AddonName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSAddonCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterConfigCmdlet"> <summary> Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with <c>DescribeUpdate</c>"/>. <para> You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html">Amazon EKS Cluster control plane logs</a> in the <i><i>Amazon EKS User Guide</i></i>. </para><note><para> CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see <a href="http://aws.amazon.com/cloudwatch/pricing/">CloudWatch Pricing</a>. </para></note><para> You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html">Amazon EKS cluster endpoint access control</a> in the <i><i>Amazon EKS User Guide</i></i>. </para><para> You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html">https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html</a> in the <i><i>Amazon EKS User Guide</i></i>. </para><para> Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to <c>UPDATING</c> (this status transition is eventually consistent). When the update is complete (either <c>Failed</c> or <c>Successful</c>), the cluster status moves to <c>Active</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterConfigCmdlet.AccessConfig_AuthenticationMode"> <summary> <para> <para>The desired authentication mode for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterConfigCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterConfigCmdlet.Logging_ClusterLogging"> <summary> <para> <para>The cluster control plane logging configuration for your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterConfigCmdlet.Name"> <summary> <para> <para>The name of the Amazon EKS cluster to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterConfigCmdlet.ResourcesVpcConfig"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Update'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.UpdateClusterConfigResponse). Specifying the name of a property of type Amazon.EKS.Model.UpdateClusterConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterVersionCmdlet"> <summary> Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the <a>DescribeUpdate</a> API operation. <para> Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to <c>UPDATING</c> (this status transition is eventually consistent). When the update is complete (either <c>Failed</c> or <c>Successful</c>), the cluster status moves to <c>Active</c>. </para><para> If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterVersionCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterVersionCmdlet.Name"> <summary> <para> <para>The name of the Amazon EKS cluster to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterVersionCmdlet.Version"> <summary> <para> <para>The desired Kubernetes version following a successful update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Update'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.UpdateClusterVersionResponse). Specifying the name of a property of type Amazon.EKS.Model.UpdateClusterVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSClusterVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSEksAnywhereSubscriptionCmdlet"> <summary> Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSEksAnywhereSubscriptionCmdlet.AutoRenew"> <summary> <para> <para>A boolean indicating whether or not to automatically renew the subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSEksAnywhereSubscriptionCmdlet.ClientRequestToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSEksAnywhereSubscriptionCmdlet.Id"> <summary> <para> <para>The ID of the subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSEksAnywhereSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Subscription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.UpdateEksAnywhereSubscriptionResponse). Specifying the name of a property of type Amazon.EKS.Model.UpdateEksAnywhereSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSEksAnywhereSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSEksAnywhereSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet"> <summary> Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the <a>DescribeUpdate</a> API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.Labels_AddOrUpdateLabel"> <summary> <para> <para>The Kubernetes <c>labels</c> to add or update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.Taints_AddOrUpdateTaint"> <summary> <para> <para>Kubernetes taints to be added or updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.ScalingConfig_DesiredSize"> <summary> <para> <para>The current number of nodes that the managed node group should maintain.</para><important><para>If you use the Kubernetes <a href="https://github.com/kubernetes/autoscaler#kubernetes-autoscaler">Cluster Autoscaler</a>, you shouldn't change the <c>desiredSize</c> value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.</para></important><para>Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.</para><para>This parameter can be different from <c>minSize</c> in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the <c>desiredSize</c> parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than <c>minSize</c> or higher than <c>maxSize</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.ScalingConfig_MaxSize"> <summary> <para> <para>The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html">Amazon EKS service quotas</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.UpdateConfig_MaxUnavailable"> <summary> <para> <para>The maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or <c>maxUnavailablePercentage</c> is required to have a value.The maximum number is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.UpdateConfig_MaxUnavailablePercentage"> <summary> <para> <para>The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or <c>maxUnavailable</c> is required to have a value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.ScalingConfig_MinSize"> <summary> <para> <para>The minimum number of nodes that the managed node group can scale in to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.NodegroupName"> <summary> <para> <para>The name of the managed node group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.Labels_RemoveLabel"> <summary> <para> <para>The Kubernetes <c>labels</c> to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.Taints_RemoveTaint"> <summary> <para> <para>Kubernetes taints to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Update'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.UpdateNodegroupConfigResponse). Specifying the name of a property of type Amazon.EKS.Model.UpdateNodegroupConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NodegroupName parameter. The -PassThru parameter is deprecated, use -Select '^NodegroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet"> <summary> Updates the Kubernetes version or AMI version of an Amazon EKS managed node group. <para> You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template. </para><para> If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For information about Linux versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html">Amazon EKS optimized Amazon Linux AMI versions</a> in the <i>Amazon EKS User Guide</i>. For information about Windows versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html">Amazon EKS optimized Windows AMI versions</a> in the <i>Amazon EKS User Guide</i>. </para><para> You cannot roll back a node group to an earlier Kubernetes version or AMI version. </para><para> When a node in a managed node group is terminated due to a scaling action or update, every <c>Pod</c> on that node is drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can <c>force</c> the update if Amazon EKS is unable to drain the nodes as a result of a <c>Pod</c> disruption budget issue. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.Enforce"> <summary> <para> <para>Force the update if any <c>Pod</c> on the existing node group can't be drained due to a <c>Pod</c> disruption budget issue. If an update fails because all Pods can't be drained, you can force the update after it fails to terminate the old node whether or not any <c>Pod</c> is running on the node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.LaunchTemplate_Id"> <summary> <para> <para>The ID of the launch template.</para><para>You must specify either the launch template ID or the launch template name in the request, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.LaunchTemplate_Name"> <summary> <para> <para>The name of the launch template.</para><para>You must specify either the launch template name or the launch template ID in the request, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.NodegroupName"> <summary> <para> <para>The name of the managed node group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.ReleaseVersion"> <summary> <para> <para>The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For information about Linux versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html">Amazon EKS optimized Amazon Linux AMI versions</a> in the <i>Amazon EKS User Guide</i>. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html">Amazon EKS optimized Windows AMI versions</a> in the <i>Amazon EKS User Guide</i>.</para><para>If you specify <c>launchTemplate</c>, and your launch template uses a custom AMI, then don't specify <c>releaseVersion</c>, or the node group update will fail. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.LaunchTemplate_Version"> <summary> <para> <para>The version number of the launch template to use. If no version is specified, then the template's default version is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.Version"> <summary> <para> <para>The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify <c>launchTemplate</c>, and your launch template uses a custom AMI, then don't specify <c>version</c>, or the node group update will fail. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Update'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.UpdateNodegroupVersionResponse). Specifying the name of a property of type Amazon.EKS.Model.UpdateNodegroupVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NodegroupName parameter. The -PassThru parameter is deprecated, use -Select '^NodegroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSNodegroupVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSPodIdentityAssociationCmdlet"> <summary> Updates a EKS Pod Identity association. Only the IAM role can be changed; an association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSPodIdentityAssociationCmdlet.AssociationId"> <summary> <para> <para>The ID of the association to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSPodIdentityAssociationCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSPodIdentityAssociationCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster that you want to update the association in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSPodIdentityAssociationCmdlet.RoleArn"> <summary> <para> <para>The new IAM role to change the </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSPodIdentityAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Association'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.UpdatePodIdentityAssociationResponse). Specifying the name of a property of type Amazon.EKS.Model.UpdatePodIdentityAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSPodIdentityAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EKS.UpdateEKSPodIdentityAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |