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 . license-manager-user-subscriptions ]

associate-user

Description

Associates the user to an EC2 instance to utilize user-based subscriptions.

Note

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide .

See also: AWS API Documentation

Synopsis

  associate-user
[--domain <value>]
--identity-provider <value>
--instance-id <value>
[--tags <value>]
--username <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

--domain (string)

The domain name of the Active Directory that contains information for the user to associate.

--identity-provider (tagged union structure)

The identity provider for the user.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.

ActiveDirectoryIdentityProvider -> (structure)

The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.

ActiveDirectorySettings -> (structure)

The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.

DomainCredentialsProvider -> (tagged union structure)

Points to the CredentialsProvider resource that contains information about the credential provider for user administration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManagerCredentialsProvider.

SecretsManagerCredentialsProvider -> (structure)

Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.

SecretId -> (string)

The ID of the Secrets Manager secret that contains credentials.

DomainIpv4List -> (list)

A list of domain IPv4 addresses that are used for the Active Directory.

(string)

DomainName -> (string)

The domain name for the Active Directory.

DomainNetworkSettings -> (structure)

The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.

Subnets -> (list)

Contains a list of subnets that apply for the Active Directory domain.

(string)

ActiveDirectoryType -> (string)

The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.

DirectoryId -> (string)

The directory ID for an Active Directory identity provider.

JSON Syntax:

{
  "ActiveDirectoryIdentityProvider": {
    "ActiveDirectorySettings": {
      "DomainCredentialsProvider": {
        "SecretsManagerCredentialsProvider": {
          "SecretId": "string"
        }
      },
      "DomainIpv4List": ["string", ...],
      "DomainName": "string",
      "DomainNetworkSettings": {
        "Subnets": ["string", ...]
      }
    },
    "ActiveDirectoryType": "SELF_MANAGED"|"AWS_MANAGED",
    "DirectoryId": "string"
  }
}

--instance-id (string)

The ID of the EC2 instance that provides the user-based subscription.

--tags (map)

The tags that apply for the user association.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--username (string)

The user name from the identity provider.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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

InstanceUserSummary -> (structure)

Metadata that describes the associate user operation.

AssociationDate -> (string)

The date a user was associated with an EC2 instance.

DisassociationDate -> (string)

The date a user was disassociated from an EC2 instance.

Domain -> (string)

The domain name of the Active Directory that contains the user information for the product subscription.

IdentityProvider -> (tagged union structure)

The IdentityProvider resource specifies details about the identity provider.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.

ActiveDirectoryIdentityProvider -> (structure)

The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.

ActiveDirectorySettings -> (structure)

The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.

DomainCredentialsProvider -> (tagged union structure)

Points to the CredentialsProvider resource that contains information about the credential provider for user administration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManagerCredentialsProvider.

SecretsManagerCredentialsProvider -> (structure)

Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.

SecretId -> (string)

The ID of the Secrets Manager secret that contains credentials.

DomainIpv4List -> (list)

A list of domain IPv4 addresses that are used for the Active Directory.

(string)

DomainName -> (string)

The domain name for the Active Directory.

DomainNetworkSettings -> (structure)

The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.

Subnets -> (list)

Contains a list of subnets that apply for the Active Directory domain.

(string)

ActiveDirectoryType -> (string)

The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.

DirectoryId -> (string)

The directory ID for an Active Directory identity provider.

InstanceId -> (string)

The ID of the EC2 instance that provides user-based subscriptions.

InstanceUserArn -> (string)

The Amazon Resource Name (ARN) that identifies the instance user.

Status -> (string)

The status of a user associated with an EC2 instance.

StatusMessage -> (string)

The status message for users of an EC2 instance.

Username -> (string)

The user name from the identity provider for the user.