attach-verified-access-trust-provider¶

Description¶

Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.

Synopsis¶

  attach-verified-access-trust-provider
--verified-access-instance-id <value>
--verified-access-trust-provider-id <value>
[--client-token <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--verified-access-instance-id (string)

The ID of the Verified Access instance.

--verified-access-trust-provider-id (string)

The ID of the Verified Access trust provider.

--client-token (string)

A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency .

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To attach a trust provider to an instance

The following attach-verified-access-trust-provider example attaches the specified Verified Access trust provider to the specified Verified Access instance.

aws ec2 attach-verified-access-trust-provider \
    --verified-access-instance-id vai-0ce000c0b7643abea \
    --verified-access-trust-provider-id vatp-0bb32de759a3e19e7

Output:

{
    "VerifiedAccessTrustProvider": {
        "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7",
        "Description": "",
        "TrustProviderType": "user",
        "UserTrustProviderType": "iam-identity-center",
        "PolicyReferenceName": "idc",
        "CreationTime": "2023-08-25T19:00:38",
        "LastUpdatedTime": "2023-08-25T19:00:38"
    },
    "VerifiedAccessInstance": {
        "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea",
        "Description": "",
        "VerifiedAccessTrustProviders": [
            {
                "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7",
                "TrustProviderType": "user",
                "UserTrustProviderType": "iam-identity-center"
            }
        ],
        "CreationTime": "2023-08-25T18:27:56",
        "LastUpdatedTime": "2023-08-25T18:27:56"
    }
}

For more information, see Verified Access instances in the AWS Verified Access User Guide.

Output¶

VerifiedAccessTrustProvider -> (structure)

Details about the Verified Access trust provider.

VerifiedAccessTrustProviderId -> (string)

The ID of the Amazon Web Services Verified Access trust provider.

Description -> (string)

A description for the Amazon Web Services Verified Access trust provider.

TrustProviderType -> (string)

The type of Verified Access trust provider.

UserTrustProviderType -> (string)

The type of user-based trust provider.

DeviceTrustProviderType -> (string)

The type of device-based trust provider.

OidcOptions -> (structure)

The options for an OpenID Connect-compatible user-identity trust provider.

Issuer -> (string)

The OIDC issuer.

AuthorizationEndpoint -> (string)

The OIDC authorization endpoint.

TokenEndpoint -> (string)

The OIDC token endpoint.

UserInfoEndpoint -> (string)

The OIDC user info endpoint.

ClientId -> (string)

The client identifier.

ClientSecret -> (string)

The client secret.

Scope -> (string)

The OpenID Connect (OIDC) scope specified.

DeviceOptions -> (structure)

The options for device-identity trust provider.

TenantId -> (string)

The ID of the tenant application with the device-identity provider.

PublicSigningKeyUrl -> (string)

The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

PolicyReferenceName -> (string)

The identifier to be used when working with policy rules.

CreationTime -> (string)

The creation time.

LastUpdatedTime -> (string)

The last updated time.

Tags -> (list)

The tags.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

SseSpecification -> (structure)

The options in use for server side encryption.

CustomerManagedKeyEnabled -> (boolean)

Indicates whether customer managed KMS keys are in use for server side encryption.

Valid values: True | False

KmsKeyArn -> (string)

The ARN of the KMS key.

NativeApplicationOidcOptions -> (structure)

The OpenID Connect (OIDC) options.

PublicSigningKeyEndpoint -> (string)

The public signing key endpoint.

Issuer -> (string)

The OIDC issuer identifier of the IdP.

AuthorizationEndpoint -> (string)

The authorization endpoint of the IdP.

TokenEndpoint -> (string)

The token endpoint of the IdP.

UserInfoEndpoint -> (string)

The user info endpoint of the IdP.

ClientId -> (string)

The OAuth 2.0 client identifier.

Scope -> (string)

The set of user claims to be requested from the IdP.

VerifiedAccessInstance -> (structure)

Details about the Verified Access instance.

VerifiedAccessInstanceId -> (string)

The ID of the Amazon Web Services Verified Access instance.

Description -> (string)

A description for the Amazon Web Services Verified Access instance.

VerifiedAccessTrustProviders -> (list)

The IDs of the Amazon Web Services Verified Access trust providers.

(structure)

Condensed information about a trust provider.

VerifiedAccessTrustProviderId -> (string)

The ID of the trust provider.

Description -> (string)

The description of trust provider.

TrustProviderType -> (string)

The type of trust provider (user- or device-based).

UserTrustProviderType -> (string)

The type of user-based trust provider.

DeviceTrustProviderType -> (string)

The type of device-based trust provider.

CreationTime -> (string)

The creation time.

LastUpdatedTime -> (string)

The last updated time.

Tags -> (list)

The tags.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

FipsEnabled -> (boolean)

Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.

CidrEndpointsCustomSubDomain -> (structure)

The custom subdomain.

SubDomain -> (string)

The subdomain.

Nameservers -> (list)

The name servers.

(string)

Table of Contents

Feedback

User Guide