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 UpdateResponderGateway API operation.

Syntax

Update-RTBResponderGateway
-AutoScalingGroups_AutoScalingGroupName <String[]>
-TrustStoreConfiguration_CertificateAuthorityCertificate <String[]>
-ClientRoutingPolicy <ClientRoutingPolicy>
-EksEndpoints_ClusterApiServerCaCertificateChain <String>
-EksEndpoints_ClusterApiServerEndpointUri <String>
-EksEndpoints_ClusterName <String>
-Description <String>
-DomainName <String>
-EksEndpoints_EndpointsResourceName <String>
-EksEndpoints_EndpointsResourceNamespace <String>
-GatewayId <String>
-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>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_StatusCodeMatcher <String>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_TimeoutMs <Int32>
-ManagedEndpointConfiguration_AutoScalingGroups_HealthCheckConfig_UnhealthyThresholdCount <Int32>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonRTBFabricConfig>

Description

Updates the description, Auto Scaling group managed endpoint configuration, trust store configuration, and client routing policy of a responder gateway. This operation also updates the protocols list in the listener configuration. You cannot change the domainName, port, and protocol values that you set when you create a responder gateway. To change any of them, delete the gateway and create a new one.

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)
-ClientRoutingPolicy <ClientRoutingPolicy>
The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. Valid values are the following:
  • AVAILABILITY_ZONE_AFFINITY: RTB Fabric routes each requester's traffic to gateway capacity in the requester's own Availability Zone when the gateway has capacity available there. Otherwise, RTB Fabric routes the traffic to gateway capacity in the other Availability Zones of the gateway.
  • ANY_AVAILABILITY_ZONE: RTB Fabric routes each requester's traffic to gateway capacity in every Availability Zone that the subnets of the gateway span. The Availability Zone that the requester is in does not change this.
If you don't specify a value, the gateway keeps its current client routing policy. Changing the policy sets the gateway status to PENDING_UPDATE until the change is complete. RTB Fabric does not support partial Availability Zone affinity, so PARTIAL_AVAILABILITY_ZONE_AFFINITY is not a valid value. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.If you don't provide this value, then Amazon Web Services generates a random one for you.If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
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>
Domain name for the responder gateway. This operation does not change the domain name of an existing gateway. To use a different domain name, delete the gateway and create a new one.
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)
-GatewayId <String>
The unique identifier of the gateway.
Required?True
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>
Networking port to use. This operation does not change the port of an existing gateway. To use a different port, delete the gateway and create a new one.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Protocol <Protocol>
Networking protocol to use. This operation does not change the protocol of an existing gateway. To use a different protocol, delete the gateway and create a new one.
Required?True
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.RTBFabric.Model.UpdateResponderGatewayResponse). Specifying the name of a property of type Amazon.RTBFabric.Model.UpdateResponderGatewayResponse 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)
-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

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.UpdateResponderGatewayResponse
This cmdlet returns an Amazon.RTBFabric.Model.UpdateResponderGatewayResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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