func RoutingControlState_Values() []string
RoutingControlState_Values returns all elements of the RoutingControlState enum
func ValidationExceptionReason_Values() []string
ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum
type AccessDeniedException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
You don't have sufficient permissions to perform this action.
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// Description of the ConflictException error
Message_ *string `locationName:"message" type:"string"`
// Identifier of the resource in use
//
// ResourceId is a required field
ResourceId *string `locationName:"resourceId" type:"string" required:"true"`
// Type of the resource in use
//
// ResourceType is a required field
ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
// contains filtered or unexported fields
}
There was a conflict with this request. Try again.
func (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EndpointTemporarilyUnavailableException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
The cluster endpoint isn't available. Try another cluster endpoint.
func (s *EndpointTemporarilyUnavailableException) Code() string
Code returns the exception type name.
func (s *EndpointTemporarilyUnavailableException) Error() string
func (s EndpointTemporarilyUnavailableException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EndpointTemporarilyUnavailableException) Message() string
Message returns the exception's message.
func (s *EndpointTemporarilyUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *EndpointTemporarilyUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *EndpointTemporarilyUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s EndpointTemporarilyUnavailableException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetRoutingControlStateInput struct {
// The Amazon Resource Name (ARN) for the routing control that you want to get
// the state for.
//
// RoutingControlArn is a required field
RoutingControlArn *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetRoutingControlStateInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetRoutingControlStateInput) SetRoutingControlArn(v string) *GetRoutingControlStateInput
SetRoutingControlArn sets the RoutingControlArn field's value.
func (s GetRoutingControlStateInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetRoutingControlStateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRoutingControlStateOutput struct {
// The Amazon Resource Name (ARN) of the response.
//
// RoutingControlArn is a required field
RoutingControlArn *string `min:"1" type:"string" required:"true"`
// The routing control name.
RoutingControlName *string `min:"1" type:"string"`
// The state of the routing control.
//
// RoutingControlState is a required field
RoutingControlState *string `type:"string" required:"true" enum:"RoutingControlState"`
// contains filtered or unexported fields
}
func (s GetRoutingControlStateOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetRoutingControlStateOutput) SetRoutingControlArn(v string) *GetRoutingControlStateOutput
SetRoutingControlArn sets the RoutingControlArn field's value.
func (s *GetRoutingControlStateOutput) SetRoutingControlName(v string) *GetRoutingControlStateOutput
SetRoutingControlName sets the RoutingControlName field's value.
func (s *GetRoutingControlStateOutput) SetRoutingControlState(v string) *GetRoutingControlStateOutput
SetRoutingControlState sets the RoutingControlState field's value.
func (s GetRoutingControlStateOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InternalServerException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// Advice to clients on when the call can be safely retried
RetryAfterSeconds *int64 `locationName:"retryAfterSeconds" type:"integer"`
// contains filtered or unexported fields
}
There was an unexpected error during processing of the request.
func (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
func (s InternalServerException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalServerException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListRoutingControlsInput struct {
// The Amazon Resource Name (ARN) of the control panel of the routing controls
// to list.
ControlPanelArn *string `min:"1" type:"string"`
// The number of routing controls objects that you want to return with this
// call. The default value is 500.
MaxResults *int64 `min:"1" type:"integer"`
// The token for the next set of results. You receive this token from a previous
// call.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListRoutingControlsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListRoutingControlsInput) SetControlPanelArn(v string) *ListRoutingControlsInput
SetControlPanelArn sets the ControlPanelArn field's value.
func (s *ListRoutingControlsInput) SetMaxResults(v int64) *ListRoutingControlsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListRoutingControlsInput) SetNextToken(v string) *ListRoutingControlsInput
SetNextToken sets the NextToken field's value.
func (s ListRoutingControlsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListRoutingControlsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListRoutingControlsOutput struct {
// The token for the next set of results. You receive this token from a previous
// call.
NextToken *string `min:"1" type:"string"`
// The list of routing controls.
//
// RoutingControls is a required field
RoutingControls []*RoutingControl `type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s ListRoutingControlsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListRoutingControlsOutput) SetNextToken(v string) *ListRoutingControlsOutput
SetNextToken sets the NextToken field's value.
func (s *ListRoutingControlsOutput) SetRoutingControls(v []*RoutingControl) *ListRoutingControlsOutput
SetRoutingControls sets the RoutingControls field's value.
func (s ListRoutingControlsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// Hypothetical resource identifier that was not found
//
// ResourceId is a required field
ResourceId *string `locationName:"resourceId" type:"string" required:"true"`
// Hypothetical resource type that was not found
//
// ResourceType is a required field
ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
// contains filtered or unexported fields
}
The request references a routing control or control panel that was not found.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Route53RecoveryCluster struct {
*client.Client
}
Route53RecoveryCluster provides the API operation methods for making requests to Route53 Recovery Cluster. See this package's package overview docs for details on the service.
Route53RecoveryCluster methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Route53RecoveryCluster
New creates a new instance of the Route53RecoveryCluster client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession())
// Create a Route53RecoveryCluster client from just a session.
svc := route53recoverycluster.New(mySession)
// Create a Route53RecoveryCluster client with additional configuration
svc := route53recoverycluster.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *Route53RecoveryCluster) GetRoutingControlState(input *GetRoutingControlStateInput) (*GetRoutingControlStateOutput, error)
GetRoutingControlState API operation for Route53 Recovery Cluster.
Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.
Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html) in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.
You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.
Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:
Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html)
Working with routing controls in Route 53 ARC (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Route53 Recovery Cluster's API operation GetRoutingControlState for usage and error information.
Returned Error Types:
AccessDeniedException You don't have sufficient permissions to perform this action.
InternalServerException There was an unexpected error during processing of the request.
ResourceNotFoundException The request references a routing control or control panel that was not found.
ValidationException There was a validation error on the request.
ThrottlingException The request was denied because of request throttling.
EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/GetRoutingControlState
func (c *Route53RecoveryCluster) GetRoutingControlStateRequest(input *GetRoutingControlStateInput) (req *request.Request, output *GetRoutingControlStateOutput)
GetRoutingControlStateRequest generates a "aws/request.Request" representing the client's request for the GetRoutingControlState operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetRoutingControlState for more information on using the GetRoutingControlState API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetRoutingControlStateRequest method.
req, resp := client.GetRoutingControlStateRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/GetRoutingControlState
func (c *Route53RecoveryCluster) GetRoutingControlStateWithContext(ctx aws.Context, input *GetRoutingControlStateInput, opts ...request.Option) (*GetRoutingControlStateOutput, error)
GetRoutingControlStateWithContext is the same as GetRoutingControlState with the addition of the ability to pass a context and additional request options.
See GetRoutingControlState for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Route53RecoveryCluster) ListRoutingControls(input *ListRoutingControlsInput) (*ListRoutingControlsOutput, error)
ListRoutingControls API operation for Route53 Recovery Cluster.
List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster.
A routing control is a simple on/off switch in Route 53 ARC that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.
Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html) in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.
You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC.
Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:
Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html)
Working with routing controls in Route 53 ARC (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Route53 Recovery Cluster's API operation ListRoutingControls for usage and error information.
Returned Error Types:
AccessDeniedException You don't have sufficient permissions to perform this action.
InternalServerException There was an unexpected error during processing of the request.
ResourceNotFoundException The request references a routing control or control panel that was not found.
ValidationException There was a validation error on the request.
ThrottlingException The request was denied because of request throttling.
EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/ListRoutingControls
func (c *Route53RecoveryCluster) ListRoutingControlsPages(input *ListRoutingControlsInput, fn func(*ListRoutingControlsOutput, bool) bool) error
ListRoutingControlsPages iterates over the pages of a ListRoutingControls operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListRoutingControls method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListRoutingControls operation.
pageNum := 0
err := client.ListRoutingControlsPages(params,
func(page *route53recoverycluster.ListRoutingControlsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *Route53RecoveryCluster) ListRoutingControlsPagesWithContext(ctx aws.Context, input *ListRoutingControlsInput, fn func(*ListRoutingControlsOutput, bool) bool, opts ...request.Option) error
ListRoutingControlsPagesWithContext same as ListRoutingControlsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Route53RecoveryCluster) ListRoutingControlsRequest(input *ListRoutingControlsInput) (req *request.Request, output *ListRoutingControlsOutput)
ListRoutingControlsRequest generates a "aws/request.Request" representing the client's request for the ListRoutingControls operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListRoutingControls for more information on using the ListRoutingControls API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListRoutingControlsRequest method.
req, resp := client.ListRoutingControlsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/ListRoutingControls
func (c *Route53RecoveryCluster) ListRoutingControlsWithContext(ctx aws.Context, input *ListRoutingControlsInput, opts ...request.Option) (*ListRoutingControlsOutput, error)
ListRoutingControlsWithContext is the same as ListRoutingControls with the addition of the ability to pass a context and additional request options.
See ListRoutingControls for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Route53RecoveryCluster) UpdateRoutingControlState(input *UpdateRoutingControlStateInput) (*UpdateRoutingControlStateOutput, error)
UpdateRoutingControlState API operation for Route53 Recovery Cluster.
Set the state of the routing control to reroute traffic. You can set the value to ON or OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not flow.
With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.
The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.
You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.
Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html)
Working with routing controls overall (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Route53 Recovery Cluster's API operation UpdateRoutingControlState for usage and error information.
Returned Error Types:
AccessDeniedException You don't have sufficient permissions to perform this action.
InternalServerException There was an unexpected error during processing of the request.
ResourceNotFoundException The request references a routing control or control panel that was not found.
ValidationException There was a validation error on the request.
ThrottlingException The request was denied because of request throttling.
EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
ConflictException There was a conflict with this request. Try again.
func (c *Route53RecoveryCluster) UpdateRoutingControlStateRequest(input *UpdateRoutingControlStateInput) (req *request.Request, output *UpdateRoutingControlStateOutput)
UpdateRoutingControlStateRequest generates a "aws/request.Request" representing the client's request for the UpdateRoutingControlState operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateRoutingControlState for more information on using the UpdateRoutingControlState API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateRoutingControlStateRequest method.
req, resp := client.UpdateRoutingControlStateRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *Route53RecoveryCluster) UpdateRoutingControlStateWithContext(ctx aws.Context, input *UpdateRoutingControlStateInput, opts ...request.Option) (*UpdateRoutingControlStateOutput, error)
UpdateRoutingControlStateWithContext is the same as UpdateRoutingControlState with the addition of the ability to pass a context and additional request options.
See UpdateRoutingControlState for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Route53RecoveryCluster) UpdateRoutingControlStates(input *UpdateRoutingControlStatesInput) (*UpdateRoutingControlStatesOutput, error)
UpdateRoutingControlStates API operation for Route53 Recovery Cluster.
Set multiple routing control states. You can set the value for each state to be ON or OFF. When the state is ON, traffic flows to a cell. When it's OFF, traffic does not flow.
With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.
The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.
You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.
Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html)
Working with routing controls overall (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Route53 Recovery Cluster's API operation UpdateRoutingControlStates for usage and error information.
Returned Error Types:
AccessDeniedException You don't have sufficient permissions to perform this action.
InternalServerException There was an unexpected error during processing of the request.
ResourceNotFoundException The request references a routing control or control panel that was not found.
ValidationException There was a validation error on the request.
ThrottlingException The request was denied because of request throttling.
EndpointTemporarilyUnavailableException The cluster endpoint isn't available. Try another cluster endpoint.
ConflictException There was a conflict with this request. Try again.
ServiceLimitExceededException The request can't update that many routing control states at the same time. Try again with fewer routing control states.
func (c *Route53RecoveryCluster) UpdateRoutingControlStatesRequest(input *UpdateRoutingControlStatesInput) (req *request.Request, output *UpdateRoutingControlStatesOutput)
UpdateRoutingControlStatesRequest generates a "aws/request.Request" representing the client's request for the UpdateRoutingControlStates operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateRoutingControlStates for more information on using the UpdateRoutingControlStates API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateRoutingControlStatesRequest method.
req, resp := client.UpdateRoutingControlStatesRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *Route53RecoveryCluster) UpdateRoutingControlStatesWithContext(ctx aws.Context, input *UpdateRoutingControlStatesInput, opts ...request.Option) (*UpdateRoutingControlStatesOutput, error)
UpdateRoutingControlStatesWithContext is the same as UpdateRoutingControlStates with the addition of the ability to pass a context and additional request options.
See UpdateRoutingControlStates for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type RoutingControl struct {
// The Amazon Resource Name (ARN) of the control panel where the routing control
// is located.
ControlPanelArn *string `min:"1" type:"string"`
// The name of the control panel where the routing control is located. Only
// ASCII characters are supported for control panel names.
ControlPanelName *string `min:"1" type:"string"`
// The Amazon Web Services account ID of the routing control owner.
Owner *string `min:"12" type:"string"`
// The Amazon Resource Name (ARN) of the routing control.
RoutingControlArn *string `min:"1" type:"string"`
// The name of the routing control.
RoutingControlName *string `min:"1" type:"string"`
// The current state of the routing control. When a routing control state is
// set to ON, traffic flows to a cell. When the state is set to OFF, traffic
// does not flow.
RoutingControlState *string `type:"string" enum:"RoutingControlState"`
// contains filtered or unexported fields
}
A routing control, which is a simple on/off switch that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.
func (s RoutingControl) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RoutingControl) SetControlPanelArn(v string) *RoutingControl
SetControlPanelArn sets the ControlPanelArn field's value.
func (s *RoutingControl) SetControlPanelName(v string) *RoutingControl
SetControlPanelName sets the ControlPanelName field's value.
func (s *RoutingControl) SetOwner(v string) *RoutingControl
SetOwner sets the Owner field's value.
func (s *RoutingControl) SetRoutingControlArn(v string) *RoutingControl
SetRoutingControlArn sets the RoutingControlArn field's value.
func (s *RoutingControl) SetRoutingControlName(v string) *RoutingControl
SetRoutingControlName sets the RoutingControlName field's value.
func (s *RoutingControl) SetRoutingControlState(v string) *RoutingControl
SetRoutingControlState sets the RoutingControlState field's value.
func (s RoutingControl) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ServiceLimitExceededException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The code of the limit that was exceeded.
//
// LimitCode is a required field
LimitCode *string `locationName:"limitCode" type:"string" required:"true"`
Message_ *string `locationName:"message" type:"string"`
// The resource identifier of the limit that was exceeded.
ResourceId *string `locationName:"resourceId" type:"string"`
// The resource type of the limit that was exceeded.
ResourceType *string `locationName:"resourceType" type:"string"`
// The service code of the limit that was exceeded.
//
// ServiceCode is a required field
ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"`
// contains filtered or unexported fields
}
The request can't update that many routing control states at the same time. Try again with fewer routing control states.
func (s *ServiceLimitExceededException) Code() string
Code returns the exception type name.
func (s *ServiceLimitExceededException) Error() string
func (s ServiceLimitExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceLimitExceededException) Message() string
Message returns the exception's message.
func (s *ServiceLimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceLimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceLimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ServiceLimitExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ThrottlingException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// Advice to clients on when the call can be safely retried
RetryAfterSeconds *int64 `locationName:"retryAfterSeconds" type:"integer"`
// contains filtered or unexported fields
}
The request was denied because of request throttling.
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ThrottlingException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateRoutingControlStateEntry struct {
// The Amazon Resource Name (ARN) for a routing control state entry.
//
// RoutingControlArn is a required field
RoutingControlArn *string `min:"1" type:"string" required:"true"`
// The routing control state in a set of routing control state entries.
//
// RoutingControlState is a required field
RoutingControlState *string `type:"string" required:"true" enum:"RoutingControlState"`
// contains filtered or unexported fields
}
A routing control state entry.
func (s UpdateRoutingControlStateEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateRoutingControlStateEntry) SetRoutingControlArn(v string) *UpdateRoutingControlStateEntry
SetRoutingControlArn sets the RoutingControlArn field's value.
func (s *UpdateRoutingControlStateEntry) SetRoutingControlState(v string) *UpdateRoutingControlStateEntry
SetRoutingControlState sets the RoutingControlState field's value.
func (s UpdateRoutingControlStateEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateRoutingControlStateEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRoutingControlStateInput struct {
// The Amazon Resource Name (ARN) for the routing control that you want to update
// the state for.
//
// RoutingControlArn is a required field
RoutingControlArn *string `min:"1" type:"string" required:"true"`
// The state of the routing control. You can set the value to ON or OFF.
//
// RoutingControlState is a required field
RoutingControlState *string `type:"string" required:"true" enum:"RoutingControlState"`
// The Amazon Resource Names (ARNs) for the safety rules that you want to override
// when you're updating the state of a routing control. You can override one
// safety rule or multiple safety rules by including one or more ARNs, separated
// by commas.
//
// For more information, see Override safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html)
// in the Amazon Route 53 Application Recovery Controller Developer Guide.
SafetyRulesToOverride []*string `type:"list"`
// contains filtered or unexported fields
}
func (s UpdateRoutingControlStateInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateRoutingControlStateInput) SetRoutingControlArn(v string) *UpdateRoutingControlStateInput
SetRoutingControlArn sets the RoutingControlArn field's value.
func (s *UpdateRoutingControlStateInput) SetRoutingControlState(v string) *UpdateRoutingControlStateInput
SetRoutingControlState sets the RoutingControlState field's value.
func (s *UpdateRoutingControlStateInput) SetSafetyRulesToOverride(v []*string) *UpdateRoutingControlStateInput
SetSafetyRulesToOverride sets the SafetyRulesToOverride field's value.
func (s UpdateRoutingControlStateInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateRoutingControlStateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRoutingControlStateOutput struct {
// contains filtered or unexported fields
}
func (s UpdateRoutingControlStateOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UpdateRoutingControlStateOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateRoutingControlStatesInput struct {
// The Amazon Resource Names (ARNs) for the safety rules that you want to override
// when you're updating routing control states. You can override one safety
// rule or multiple safety rules by including one or more ARNs, separated by
// commas.
//
// For more information, see Override safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html)
// in the Amazon Route 53 Application Recovery Controller Developer Guide.
SafetyRulesToOverride []*string `type:"list"`
// A set of routing control entries that you want to update.
//
// UpdateRoutingControlStateEntries is a required field
UpdateRoutingControlStateEntries []*UpdateRoutingControlStateEntry `type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s UpdateRoutingControlStatesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateRoutingControlStatesInput) SetSafetyRulesToOverride(v []*string) *UpdateRoutingControlStatesInput
SetSafetyRulesToOverride sets the SafetyRulesToOverride field's value.
func (s *UpdateRoutingControlStatesInput) SetUpdateRoutingControlStateEntries(v []*UpdateRoutingControlStateEntry) *UpdateRoutingControlStatesInput
SetUpdateRoutingControlStateEntries sets the UpdateRoutingControlStateEntries field's value.
func (s UpdateRoutingControlStatesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateRoutingControlStatesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRoutingControlStatesOutput struct {
// contains filtered or unexported fields
}
func (s UpdateRoutingControlStatesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UpdateRoutingControlStatesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValidationException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The fields that caused the error, if applicable
Fields []*ValidationExceptionField `locationName:"fields" type:"list"`
Message_ *string `locationName:"message" type:"string"`
// Reason the request failed validation
Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"`
// contains filtered or unexported fields
}
There was a validation error on the request.
func (s *ValidationException) Code() string
Code returns the exception type name.
func (s *ValidationException) Error() string
func (s ValidationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ValidationException) Message() string
Message returns the exception's message.
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValidationExceptionField struct {
// Information about the validation exception.
//
// Message is a required field
Message *string `locationName:"message" type:"string" required:"true"`
// The field that had the validation exception.
//
// Name is a required field
Name *string `locationName:"name" type:"string" required:"true"`
// contains filtered or unexported fields
}
There was a validation error on the request.
func (s ValidationExceptionField) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField
SetMessage sets the Message field's value.
func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField
SetName sets the Name field's value.
func (s ValidationExceptionField) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".