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 VPC Lattice CreateResourceConfiguration API operation.

Syntax

New-VPCLResourceConfiguration
-Name <String>
-AllowAssociationToShareableServiceNetwork <Boolean>
-ArnResource_Arn <String>
-CustomDomainName <String>
-DnsResource_DomainName <String>
-DomainVerificationIdentifier <String>
-GroupDomain <String>
-IpResource_IpAddress <String>
-DnsResource_IpAddressType <ResourceConfigurationIpAddressType>
-PortRange <String[]>
-Protocol <ProtocolType>
-ResourceConfigurationGroupIdentifier <String>
-ResourceGatewayIdentifier <String>
-Tag <Hashtable>
-Type <ResourceConfigurationType>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonVPCLatticeConfig>

Description

Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.

Parameters

-AllowAssociationToShareableServiceNetwork <Boolean>
(SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ArnResource_Arn <String>
The Amazon Resource Name (ARN) of the resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfigurationDefinition_ArnResource_Arn
-ClientConfig <AmazonVPCLatticeConfig>
Amazon.PowerShell.Cmdlets.VPCL.AmazonVPCLatticeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomDomainName <String>
A custom domain name for your resource configuration. Additionally, provide a DomainVerificationID to prove your ownership of a domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DnsResource_DomainName <String>
The domain name of the resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfigurationDefinition_DnsResource_DomainName
-DnsResource_IpAddressType <ResourceConfigurationIpAddressType>
The type of IP address. Dualstack is currently not supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfigurationDefinition_DnsResource_IpAddressType
-DomainVerificationIdentifier <String>
The domain verification ID of your verified custom domain name. If you don't provide an ID, you must configure the DNS settings yourself.
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)
-GroupDomain <String>
(GROUP) The group domain for a group resource configuration. Any domains that you create for the child resource are subdomains of the group domain. Child resources inherit the verification status of the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IpResource_IpAddress <String>
The IP address of the IP resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfigurationDefinition_IpResource_IpAddress
-Name <String>
The name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PortRange <String[]>
(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPortRanges
-Protocol <ProtocolType>
(SINGLE, GROUP) The protocol accepted by the resource configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceConfigurationGroupIdentifier <String>
(CHILD) The ID or ARN of the parent resource configuration of type GROUP. This is used to associate a child resource configuration with a group resource configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceGatewayIdentifier <String>
(SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.VPCLattice.Model.CreateResourceConfigurationResponse). Specifying the name of a property of type Amazon.VPCLattice.Model.CreateResourceConfigurationResponse 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)
-Tag <Hashtable>
The tags for the resource configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Type <ResourceConfigurationType>
The type of resource configuration. A resource configuration can be one of the following types:
  • SINGLE - A single resource.
  • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.
  • CHILD - A single resource that is part of a group resource configuration.
  • ARN - An Amazon Web Services resource.
Required?True
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.VPCLattice.Model.CreateResourceConfigurationResponse
This cmdlet returns an Amazon.VPCLattice.Model.CreateResourceConfigurationResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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