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 RTBFabric CreateResponderGateway API operation.

Syntax

New-RTBResponderGateway
-AutoScalingGroups_AutoScalingGroupName <String[]>
-TrustStoreConfiguration_CertificateAuthorityCertificate <String[]>
-EksEndpoints_ClusterApiServerCaCertificateChain <String>
-EksEndpoints_ClusterApiServerEndpointUri <String>
-EksEndpoints_ClusterName <String>
-Description <String>
-DomainName <String>
-EksEndpoints_EndpointsResourceName <String>
-EksEndpoints_EndpointsResourceNamespace <String>
-GatewayType <GatewayType>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_HealthyThresholdCount <Int32>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_IntervalSecond <Int32>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_Path <String>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_Port <Int32>
-Port <Int32>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_Protocol <Protocol>
-Protocol <Protocol>
-ListenerConfig_Protocol <String[]>
-AutoScalingGroups_RoleArn <String>
-EksEndpoints_RoleArn <String>
-SecurityGroupId <String[]>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_StatusCodeMatcher <String>
-SubnetId <String[]>
-Tag <Hashtable>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_TimeoutMs <Int32>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_UnhealthyThresholdCount <Int32>
-VpcId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonRTBFabricConfig>

Description

Creates a responder gateway. A domain name or managed endpoint is required.

Parameters

-AutoScalingGroups_AutoScalingGroupName <String[]>
The names of the auto scaling group. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedEndpointConfiguration_AutoScalingGroups_AutoScalingGroupNames
-AutoScalingGroups_RoleArn <String>
The role ARN of the auto scaling group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedEndpointConfiguration_AutoScalingGroups_RoleArn
-ClientConfig <AmazonRTBFabricConfig>
Amazon.PowerShell.Cmdlets.RTB.AmazonRTBFabricClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
The unique client token.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
An optional description for the responder gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainName <String>
The domain name for the responder gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EksEndpoints_ClusterApiServerCaCertificateChain <String>
The CA certificate chain of the cluster API server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedEndpointConfiguration_EksEndpoints_ClusterApiServerCaCertificateChain
-EksEndpoints_ClusterApiServerEndpointUri <String>
The URI of the cluster API server endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedEndpointConfiguration_EksEndpoints_ClusterApiServerEndpointUri
-EksEndpoints_ClusterName <String>
The name of the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedEndpointConfiguration_EksEndpoints_ClusterName
-EksEndpoints_EndpointsResourceName <String>
The name of the endpoint resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedEndpointConfiguration_EksEndpoints_EndpointsResourceName
-EksEndpoints_EndpointsResourceNamespace <String>
The namespace of the endpoint resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedEndpointConfiguration_EksEndpoints_EndpointsResourceNamespace
-EksEndpoints_RoleArn <String>
The role ARN for the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedEndpointConfiguration_EksEndpoints_RoleArn
-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)
-GatewayType <GatewayType>
The type of gateway. Valid values are EXTERNAL or INTERNAL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ListenerConfig_Protocol <String[]>
The protocol for connections from clients to the gateway Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesListenerConfig_Protocols
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_HealthyThresholdCount <Int32>
The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_IntervalSecond <Int32>
The interval between health check probes, in seconds. Valid range is 5 to 60.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_IntervalSeconds
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_Path <String>
The destination path for the health check request. Must start with /.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_Port <Int32>
The port to use for health check probes. Valid range is 80 to 65535.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_Protocol <Protocol>
The protocol to use for health check probes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_StatusCodeMatcher <String>
The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_TimeoutMs <Int32>
The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_UnhealthyThresholdCount <Int32>
The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The networking port to use.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Protocol <Protocol>
The networking protocol to use.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupId <String[]>
The unique identifiers of the security groups. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupIds
-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.RTBFabric.Model.CreateResponderGatewayResponse). Specifying the name of a property of type Amazon.RTBFabric.Model.CreateResponderGatewayResponse 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)
-SubnetId <String[]>
The unique identifiers of the subnets. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnetIds
-Tag <Hashtable>
A map of the key-value pairs of the tag or tags to assign to the resource. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TrustStoreConfiguration_CertificateAuthorityCertificate <String[]>
The certificate authority certificate. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrustStoreConfiguration_CertificateAuthorityCertificates
-VpcId <String>
The unique identifier of the Virtual Private Cloud (VPC).
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.RTBFabric.Model.CreateResponderGatewayResponse
This cmdlet returns an Amazon.RTBFabric.Model.CreateResponderGatewayResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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