AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) CreateVerifiedAccessTrustProvider API operation.

Syntax

New-EC2VerifiedAccessTrustProvider
-TrustProviderType <TrustProviderType>
-NativeApplicationOidcOptions_AuthorizationEndpoint <String>
-OidcOptions_AuthorizationEndpoint <String>
-NativeApplicationOidcOptions_ClientId <String>
-OidcOptions_ClientId <String>
-NativeApplicationOidcOptions_ClientSecret <String>
-OidcOptions_ClientSecret <String>
-SseSpecification_CustomerManagedKeyEnabled <Boolean>
-Description <String>
-DeviceTrustProviderType <DeviceTrustProviderType>
-NativeApplicationOidcOptions_Issuer <String>
-OidcOptions_Issuer <String>
-SseSpecification_KmsKeyArn <String>
-PolicyReferenceName <String>
-NativeApplicationOidcOptions_PublicSigningKeyEndpoint <String>
-DeviceOptions_PublicSigningKeyUrl <String>
-NativeApplicationOidcOptions_Scope <String>
-OidcOptions_Scope <String>
-TagSpecification <TagSpecification[]>
-DeviceOptions_TenantId <String>
-NativeApplicationOidcOptions_TokenEndpoint <String>
-OidcOptions_TokenEndpoint <String>
-NativeApplicationOidcOptions_UserInfoEndpoint <String>
-OidcOptions_UserInfoEndpoint <String>
-UserTrustProviderType <UserTrustProviderType>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.

Parameters

-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description for the Verified Access trust provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceOptions_PublicSigningKeyUrl <String>
The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceOptions_TenantId <String>
The ID of the tenant application with the device-identity provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceTrustProviderType <DeviceTrustProviderType>
The type of device-based trust provider. This parameter is required when the provider type is device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NativeApplicationOidcOptions_AuthorizationEndpoint <String>
The authorization endpoint of the IdP.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NativeApplicationOidcOptions_ClientId <String>
The OAuth 2.0 client identifier.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NativeApplicationOidcOptions_ClientSecret <String>
The OAuth 2.0 client secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NativeApplicationOidcOptions_Issuer <String>
The OIDC issuer identifier of the IdP.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NativeApplicationOidcOptions_PublicSigningKeyEndpoint <String>
The public signing key endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NativeApplicationOidcOptions_Scope <String>
The set of user claims to be requested from the IdP.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NativeApplicationOidcOptions_TokenEndpoint <String>
The token endpoint of the IdP.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NativeApplicationOidcOptions_UserInfoEndpoint <String>
The user info endpoint of the IdP.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcOptions_AuthorizationEndpoint <String>
The OIDC authorization endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcOptions_ClientId <String>
The client identifier.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcOptions_ClientSecret <String>
The client secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcOptions_Issuer <String>
The OIDC issuer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcOptions_Scope <String>
OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcOptions_TokenEndpoint <String>
The OIDC token endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcOptions_UserInfoEndpoint <String>
The OIDC user info endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the TrustProviderType parameter. The -PassThru parameter is deprecated, use -Select '^TrustProviderType' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyReferenceName <String>
The identifier to be used when working with policy rules.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'VerifiedAccessTrustProvider'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateVerifiedAccessTrustProviderResponse). Specifying the name of a property of type Amazon.EC2.Model.CreateVerifiedAccessTrustProviderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SseSpecification_CustomerManagedKeyEnabled <Boolean>
Enable or disable the use of customer managed KMS keys for server side encryption.Valid values: True | False
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SseSpecification_KmsKeyArn <String>
The ARN of the KMS key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TagSpecification <TagSpecification[]>
The tags to assign to the Verified Access trust provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTagSpecifications
-TrustProviderType <TrustProviderType>
The type of trust provider.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-UserTrustProviderType <UserTrustProviderType>
The type of user-based trust provider. This parameter is required when the provider type is user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EC2.Model.VerifiedAccessTrustProvider or Amazon.EC2.Model.CreateVerifiedAccessTrustProviderResponse
This cmdlet returns an Amazon.EC2.Model.VerifiedAccessTrustProvider object. The service call response (type Amazon.EC2.Model.CreateVerifiedAccessTrustProviderResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z