AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . eks ]

associate-access-policy

Description

Associates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entries in the Amazon EKS User Guide .

See also: AWS API Documentation

Synopsis

  associate-access-policy
--cluster-name <value>
--principal-arn <value>
--policy-arn <value>
--access-scope <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--cluster-name (string)

The name of your cluster.

--principal-arn (string)

The Amazon Resource Name (ARN) of the IAM user or role for the AccessEntry that you're associating the access policy to.

--policy-arn (string)

The ARN of the AccessPolicy that you're associating. For a list of ARNs, use ListAccessPolicies .

--access-scope (structure)

The scope for the AccessPolicy . You can scope access policies to an entire cluster or to specific Kubernetes namespaces.

type -> (string)

The scope type of an access policy.

namespaces -> (list)

A Kubernetes namespace that an access policy is scoped to. A value is required if you specified namespace for Type .

(string)

Shorthand Syntax:

type=string,namespaces=string,string

JSON Syntax:

{
  "type": "cluster"|"namespace",
  "namespaces": ["string", ...]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

clusterName -> (string)

The name of your cluster.

principalArn -> (string)

The ARN of the IAM principal for the AccessEntry .

associatedAccessPolicy -> (structure)

The AccessPolicy and scope associated to the AccessEntry .

policyArn -> (string)

The ARN of the AccessPolicy .

accessScope -> (structure)

The scope of the access policy.

type -> (string)

The scope type of an access policy.

namespaces -> (list)

A Kubernetes namespace that an access policy is scoped to. A value is required if you specified namespace for Type .

(string)

associatedAt -> (timestamp)

The date and time the AccessPolicy was associated with an AccessEntry .

modifiedAt -> (timestamp)

The Unix epoch timestamp for the last modification to the object.