func AppliedStatus_Values() []string
AppliedStatus_Values returns all elements of the AppliedStatus enum
func AutoshiftAppliedStatus_Values() []string
AutoshiftAppliedStatus_Values returns all elements of the AutoshiftAppliedStatus enum
func AutoshiftExecutionStatus_Values() []string
AutoshiftExecutionStatus_Values returns all elements of the AutoshiftExecutionStatus enum
func ConflictExceptionReason_Values() []string
ConflictExceptionReason_Values returns all elements of the ConflictExceptionReason enum
func ControlConditionType_Values() []string
ControlConditionType_Values returns all elements of the ControlConditionType enum
func PracticeRunOutcome_Values() []string
PracticeRunOutcome_Values returns all elements of the PracticeRunOutcome enum
func ValidationExceptionReason_Values() []string
ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum
func ZonalAutoshiftStatus_Values() []string
ZonalAutoshiftStatus_Values returns all elements of the ZonalAutoshiftStatus enum
func ZonalShiftStatus_Values() []string
ZonalShiftStatus_Values returns all elements of the ZonalShiftStatus enum
type ARCZonalShift struct {
*client.Client
}
ARCZonalShift provides the API operation methods for making requests to AWS ARC - Zonal Shift. See this package's package overview docs for details on the service.
ARCZonalShift 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) *ARCZonalShift
New creates a new instance of the ARCZonalShift 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 ARCZonalShift client from just a session.
svc := arczonalshift.New(mySession)
// Create a ARCZonalShift client with additional configuration
svc := arczonalshift.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *ARCZonalShift) CancelZonalShift(input *CancelZonalShiftInput) (*CancelZonalShiftOutput, error)
CancelZonalShift API operation for AWS ARC - Zonal Shift.
Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.
A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.
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 AWS ARC - Zonal Shift's API operation CancelZonalShift for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ConflictException The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException The input requested a resource that was not found.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelZonalShift
func (c *ARCZonalShift) CancelZonalShiftRequest(input *CancelZonalShiftInput) (req *request.Request, output *CancelZonalShiftOutput)
CancelZonalShiftRequest generates a "aws/request.Request" representing the client's request for the CancelZonalShift 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 CancelZonalShift for more information on using the CancelZonalShift 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 CancelZonalShiftRequest method.
req, resp := client.CancelZonalShiftRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelZonalShift
func (c *ARCZonalShift) CancelZonalShiftWithContext(ctx aws.Context, input *CancelZonalShiftInput, opts ...request.Option) (*CancelZonalShiftOutput, error)
CancelZonalShiftWithContext is the same as CancelZonalShift with the addition of the ability to pass a context and additional request options.
See CancelZonalShift 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 *ARCZonalShift) CreatePracticeRunConfiguration(input *CreatePracticeRunConfigurationInput) (*CreatePracticeRunConfigurationOutput, error)
CreatePracticeRunConfiguration API operation for AWS ARC - Zonal Shift.
A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.
For more information, see Considerations when you configure zonal autoshift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.
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 AWS ARC - Zonal Shift's API operation CreatePracticeRunConfiguration for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ConflictException The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException The input requested a resource that was not found.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CreatePracticeRunConfiguration
func (c *ARCZonalShift) CreatePracticeRunConfigurationRequest(input *CreatePracticeRunConfigurationInput) (req *request.Request, output *CreatePracticeRunConfigurationOutput)
CreatePracticeRunConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreatePracticeRunConfiguration 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 CreatePracticeRunConfiguration for more information on using the CreatePracticeRunConfiguration 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 CreatePracticeRunConfigurationRequest method.
req, resp := client.CreatePracticeRunConfigurationRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CreatePracticeRunConfiguration
func (c *ARCZonalShift) CreatePracticeRunConfigurationWithContext(ctx aws.Context, input *CreatePracticeRunConfigurationInput, opts ...request.Option) (*CreatePracticeRunConfigurationOutput, error)
CreatePracticeRunConfigurationWithContext is the same as CreatePracticeRunConfiguration with the addition of the ability to pass a context and additional request options.
See CreatePracticeRunConfiguration 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 *ARCZonalShift) DeletePracticeRunConfiguration(input *DeletePracticeRunConfigurationInput) (*DeletePracticeRunConfigurationOutput, error)
DeletePracticeRunConfiguration API operation for AWS ARC - Zonal Shift.
Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.
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 AWS ARC - Zonal Shift's API operation DeletePracticeRunConfiguration for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ConflictException The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException The input requested a resource that was not found.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/DeletePracticeRunConfiguration
func (c *ARCZonalShift) DeletePracticeRunConfigurationRequest(input *DeletePracticeRunConfigurationInput) (req *request.Request, output *DeletePracticeRunConfigurationOutput)
DeletePracticeRunConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeletePracticeRunConfiguration 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 DeletePracticeRunConfiguration for more information on using the DeletePracticeRunConfiguration 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 DeletePracticeRunConfigurationRequest method.
req, resp := client.DeletePracticeRunConfigurationRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/DeletePracticeRunConfiguration
func (c *ARCZonalShift) DeletePracticeRunConfigurationWithContext(ctx aws.Context, input *DeletePracticeRunConfigurationInput, opts ...request.Option) (*DeletePracticeRunConfigurationOutput, error)
DeletePracticeRunConfigurationWithContext is the same as DeletePracticeRunConfiguration with the addition of the ability to pass a context and additional request options.
See DeletePracticeRunConfiguration 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 *ARCZonalShift) GetManagedResource(input *GetManagedResourceInput) (*GetManagedResourceOutput, error)
GetManagedResource API operation for AWS ARC - Zonal Shift.
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
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 AWS ARC - Zonal Shift's API operation GetManagedResource for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ResourceNotFoundException The input requested a resource that was not found.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResource
func (c *ARCZonalShift) GetManagedResourceRequest(input *GetManagedResourceInput) (req *request.Request, output *GetManagedResourceOutput)
GetManagedResourceRequest generates a "aws/request.Request" representing the client's request for the GetManagedResource 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 GetManagedResource for more information on using the GetManagedResource 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 GetManagedResourceRequest method.
req, resp := client.GetManagedResourceRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResource
func (c *ARCZonalShift) GetManagedResourceWithContext(ctx aws.Context, input *GetManagedResourceInput, opts ...request.Option) (*GetManagedResourceOutput, error)
GetManagedResourceWithContext is the same as GetManagedResource with the addition of the ability to pass a context and additional request options.
See GetManagedResource 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 *ARCZonalShift) ListAutoshifts(input *ListAutoshiftsInput) (*ListAutoshiftsOutput, error)
ListAutoshifts API operation for AWS ARC - Zonal Shift.
Returns the active autoshifts for a specified resource.
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 AWS ARC - Zonal Shift's API operation ListAutoshifts for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListAutoshifts
func (c *ARCZonalShift) ListAutoshiftsPages(input *ListAutoshiftsInput, fn func(*ListAutoshiftsOutput, bool) bool) error
ListAutoshiftsPages iterates over the pages of a ListAutoshifts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListAutoshifts 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 ListAutoshifts operation.
pageNum := 0
err := client.ListAutoshiftsPages(params,
func(page *arczonalshift.ListAutoshiftsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *ARCZonalShift) ListAutoshiftsPagesWithContext(ctx aws.Context, input *ListAutoshiftsInput, fn func(*ListAutoshiftsOutput, bool) bool, opts ...request.Option) error
ListAutoshiftsPagesWithContext same as ListAutoshiftsPages 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 *ARCZonalShift) ListAutoshiftsRequest(input *ListAutoshiftsInput) (req *request.Request, output *ListAutoshiftsOutput)
ListAutoshiftsRequest generates a "aws/request.Request" representing the client's request for the ListAutoshifts 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 ListAutoshifts for more information on using the ListAutoshifts 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 ListAutoshiftsRequest method.
req, resp := client.ListAutoshiftsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListAutoshifts
func (c *ARCZonalShift) ListAutoshiftsWithContext(ctx aws.Context, input *ListAutoshiftsInput, opts ...request.Option) (*ListAutoshiftsOutput, error)
ListAutoshiftsWithContext is the same as ListAutoshifts with the addition of the ability to pass a context and additional request options.
See ListAutoshifts 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 *ARCZonalShift) ListManagedResources(input *ListManagedResourcesInput) (*ListManagedResourcesOutput, error)
ListManagedResources API operation for AWS ARC - Zonal Shift.
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.
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 AWS ARC - Zonal Shift's API operation ListManagedResources for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListManagedResources
func (c *ARCZonalShift) ListManagedResourcesPages(input *ListManagedResourcesInput, fn func(*ListManagedResourcesOutput, bool) bool) error
ListManagedResourcesPages iterates over the pages of a ListManagedResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListManagedResources 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 ListManagedResources operation.
pageNum := 0
err := client.ListManagedResourcesPages(params,
func(page *arczonalshift.ListManagedResourcesOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *ARCZonalShift) ListManagedResourcesPagesWithContext(ctx aws.Context, input *ListManagedResourcesInput, fn func(*ListManagedResourcesOutput, bool) bool, opts ...request.Option) error
ListManagedResourcesPagesWithContext same as ListManagedResourcesPages 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 *ARCZonalShift) ListManagedResourcesRequest(input *ListManagedResourcesInput) (req *request.Request, output *ListManagedResourcesOutput)
ListManagedResourcesRequest generates a "aws/request.Request" representing the client's request for the ListManagedResources 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 ListManagedResources for more information on using the ListManagedResources 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 ListManagedResourcesRequest method.
req, resp := client.ListManagedResourcesRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListManagedResources
func (c *ARCZonalShift) ListManagedResourcesWithContext(ctx aws.Context, input *ListManagedResourcesInput, opts ...request.Option) (*ListManagedResourcesOutput, error)
ListManagedResourcesWithContext is the same as ListManagedResources with the addition of the ability to pass a context and additional request options.
See ListManagedResources 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 *ARCZonalShift) ListZonalShifts(input *ListZonalShiftsInput) (*ListZonalShiftsOutput, error)
ListZonalShifts API operation for AWS ARC - Zonal Shift.
Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-started zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.
The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts (https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.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 AWS ARC - Zonal Shift's API operation ListZonalShifts for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListZonalShifts
func (c *ARCZonalShift) ListZonalShiftsPages(input *ListZonalShiftsInput, fn func(*ListZonalShiftsOutput, bool) bool) error
ListZonalShiftsPages iterates over the pages of a ListZonalShifts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListZonalShifts 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 ListZonalShifts operation.
pageNum := 0
err := client.ListZonalShiftsPages(params,
func(page *arczonalshift.ListZonalShiftsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *ARCZonalShift) ListZonalShiftsPagesWithContext(ctx aws.Context, input *ListZonalShiftsInput, fn func(*ListZonalShiftsOutput, bool) bool, opts ...request.Option) error
ListZonalShiftsPagesWithContext same as ListZonalShiftsPages 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 *ARCZonalShift) ListZonalShiftsRequest(input *ListZonalShiftsInput) (req *request.Request, output *ListZonalShiftsOutput)
ListZonalShiftsRequest generates a "aws/request.Request" representing the client's request for the ListZonalShifts 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 ListZonalShifts for more information on using the ListZonalShifts 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 ListZonalShiftsRequest method.
req, resp := client.ListZonalShiftsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListZonalShifts
func (c *ARCZonalShift) ListZonalShiftsWithContext(ctx aws.Context, input *ListZonalShiftsInput, opts ...request.Option) (*ListZonalShiftsOutput, error)
ListZonalShiftsWithContext is the same as ListZonalShifts with the addition of the ability to pass a context and additional request options.
See ListZonalShifts 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 *ARCZonalShift) StartZonalShift(input *StartZonalShiftInput) (*StartZonalShiftOutput, error)
StartZonalShift API operation for AWS ARC - Zonal Shift.
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.
For more information, see Zonal shift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.
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 AWS ARC - Zonal Shift's API operation StartZonalShift for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ConflictException The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException The input requested a resource that was not found.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartZonalShift
func (c *ARCZonalShift) StartZonalShiftRequest(input *StartZonalShiftInput) (req *request.Request, output *StartZonalShiftOutput)
StartZonalShiftRequest generates a "aws/request.Request" representing the client's request for the StartZonalShift 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 StartZonalShift for more information on using the StartZonalShift 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 StartZonalShiftRequest method.
req, resp := client.StartZonalShiftRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartZonalShift
func (c *ARCZonalShift) StartZonalShiftWithContext(ctx aws.Context, input *StartZonalShiftInput, opts ...request.Option) (*StartZonalShiftOutput, error)
StartZonalShiftWithContext is the same as StartZonalShift with the addition of the ability to pass a context and additional request options.
See StartZonalShift 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 *ARCZonalShift) UpdatePracticeRunConfiguration(input *UpdatePracticeRunConfigurationInput) (*UpdatePracticeRunConfigurationOutput, error)
UpdatePracticeRunConfiguration API operation for AWS ARC - Zonal Shift.
Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
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 AWS ARC - Zonal Shift's API operation UpdatePracticeRunConfiguration for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ConflictException The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException The input requested a resource that was not found.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdatePracticeRunConfiguration
func (c *ARCZonalShift) UpdatePracticeRunConfigurationRequest(input *UpdatePracticeRunConfigurationInput) (req *request.Request, output *UpdatePracticeRunConfigurationOutput)
UpdatePracticeRunConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdatePracticeRunConfiguration 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 UpdatePracticeRunConfiguration for more information on using the UpdatePracticeRunConfiguration 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 UpdatePracticeRunConfigurationRequest method.
req, resp := client.UpdatePracticeRunConfigurationRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdatePracticeRunConfiguration
func (c *ARCZonalShift) UpdatePracticeRunConfigurationWithContext(ctx aws.Context, input *UpdatePracticeRunConfigurationInput, opts ...request.Option) (*UpdatePracticeRunConfigurationOutput, error)
UpdatePracticeRunConfigurationWithContext is the same as UpdatePracticeRunConfiguration with the addition of the ability to pass a context and additional request options.
See UpdatePracticeRunConfiguration 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 *ARCZonalShift) UpdateZonalAutoshiftConfiguration(input *UpdateZonalAutoshiftConfigurationInput) (*UpdateZonalAutoshiftConfigurationOutput, error)
UpdateZonalAutoshiftConfiguration API operation for AWS ARC - Zonal Shift.
You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift. When zonal autoshift is ENABLED, Amazon Web Services shifts away resource traffic from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.
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 AWS ARC - Zonal Shift's API operation UpdateZonalAutoshiftConfiguration for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ConflictException The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException The input requested a resource that was not found.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalAutoshiftConfiguration
func (c *ARCZonalShift) UpdateZonalAutoshiftConfigurationRequest(input *UpdateZonalAutoshiftConfigurationInput) (req *request.Request, output *UpdateZonalAutoshiftConfigurationOutput)
UpdateZonalAutoshiftConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateZonalAutoshiftConfiguration 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 UpdateZonalAutoshiftConfiguration for more information on using the UpdateZonalAutoshiftConfiguration 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 UpdateZonalAutoshiftConfigurationRequest method.
req, resp := client.UpdateZonalAutoshiftConfigurationRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalAutoshiftConfiguration
func (c *ARCZonalShift) UpdateZonalAutoshiftConfigurationWithContext(ctx aws.Context, input *UpdateZonalAutoshiftConfigurationInput, opts ...request.Option) (*UpdateZonalAutoshiftConfigurationOutput, error)
UpdateZonalAutoshiftConfigurationWithContext is the same as UpdateZonalAutoshiftConfiguration with the addition of the ability to pass a context and additional request options.
See UpdateZonalAutoshiftConfiguration 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 *ARCZonalShift) UpdateZonalShift(input *UpdateZonalShiftInput) (*UpdateZonalShiftOutput, error)
UpdateZonalShift API operation for AWS ARC - Zonal Shift.
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
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 AWS ARC - Zonal Shift's API operation UpdateZonalShift for usage and error information.
Returned Error Types:
InternalServerException There was an internal server error.
ConflictException The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException The input requested a resource that was not found.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalShift
func (c *ARCZonalShift) UpdateZonalShiftRequest(input *UpdateZonalShiftInput) (req *request.Request, output *UpdateZonalShiftOutput)
UpdateZonalShiftRequest generates a "aws/request.Request" representing the client's request for the UpdateZonalShift 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 UpdateZonalShift for more information on using the UpdateZonalShift 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 UpdateZonalShiftRequest method.
req, resp := client.UpdateZonalShiftRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalShift
func (c *ARCZonalShift) UpdateZonalShiftWithContext(ctx aws.Context, input *UpdateZonalShiftInput, opts ...request.Option) (*UpdateZonalShiftOutput, error)
UpdateZonalShiftWithContext is the same as UpdateZonalShift with the addition of the ability to pass a context and additional request options.
See UpdateZonalShift 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 AccessDeniedException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
You do not have sufficient access 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 AutoshiftInResource struct {
// The appliedStatus field specifies which application traffic shift is in effect
// for a resource when there is more than one traffic shift active. There can
// be more than one application traffic shift in progress at the same time -
// that is, practice run zonal shifts, customer-started zonal shifts, or an
// autoshift. The appliedStatus field for an autoshift for a resource can have
// one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that
// is currently in effect for the resource has an applied status set to APPLIED.
//
// The overall principle for precedence is that zonal shifts that you start
// as a customer take precedence autoshifts, which take precedence over practice
// runs. That is, customer-started zonal shifts > autoshifts > practice run
// zonal shifts.
//
// For more information, see How zonal autoshift and practice runs work (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html)
// in the Amazon Route 53 Application Recovery Controller Developer Guide.
//
// AppliedStatus is a required field
AppliedStatus *string `locationName:"appliedStatus" type:"string" required:"true" enum:"AutoshiftAppliedStatus"`
// The Availability Zone that traffic is shifted away from for a resource, when
// Amazon Web Services starts an autoshift. Until the autoshift ends, traffic
// for the resource is instead directed to other Availability Zones in the Amazon
// Web Services Region. An autoshift can end for a resource, for example, when
// Amazon Web Services ends the autoshift for the Availability Zone or when
// you disable zonal autoshift for the resource.
//
// AwayFrom is a required field
AwayFrom *string `locationName:"awayFrom" type:"string" required:"true"`
// The time (UTC) when the autoshift started.
//
// StartTime is a required field
StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`
// contains filtered or unexported fields
}
A complex structure that lists an autoshift that is currently active for a managed resource and information about the autoshift.
For more information, see How zonal autoshift and practice runs work (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.
func (s AutoshiftInResource) 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 *AutoshiftInResource) SetAppliedStatus(v string) *AutoshiftInResource
SetAppliedStatus sets the AppliedStatus field's value.
func (s *AutoshiftInResource) SetAwayFrom(v string) *AutoshiftInResource
SetAwayFrom sets the AwayFrom field's value.
func (s *AutoshiftInResource) SetStartTime(v time.Time) *AutoshiftInResource
SetStartTime sets the StartTime field's value.
func (s AutoshiftInResource) 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 AutoshiftSummary struct {
// The Availability Zone that traffic is shifted away from for a resource when
// Amazon Web Services starts an autoshift. Until the autoshift ends, traffic
// for the resource is instead directed to other Availability Zones in the Amazon
// Web Services Region. An autoshift can end for a resource, for example, when
// Amazon Web Services ends the autoshift for the Availability Zone or when
// you disable zonal autoshift for the resource.
//
// AwayFrom is a required field
AwayFrom *string `locationName:"awayFrom" type:"string" required:"true"`
// The time (in UTC) when the autoshift ended.
//
// EndTime is a required field
EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`
// The time (in UTC) when the autoshift started.
//
// StartTime is a required field
StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`
// The status for an autoshift.
//
// Status is a required field
Status *string `locationName:"status" type:"string" required:"true" enum:"AutoshiftExecutionStatus"`
// contains filtered or unexported fields
}
Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource away from an Availability Zone in an Amazon Web Services Region when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers. You can configure zonal autoshift in Route 53 ARC for managed resources in your Amazon Web Services account in a Region. Supported Amazon Web Services resources are automatically registered with Route 53 ARC.
Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and traffic for the resource is no longer directed to the other Availability Zones in the Region.
You can stop an autoshift for a resource by disabling zonal autoshift.
func (s AutoshiftSummary) 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 *AutoshiftSummary) SetAwayFrom(v string) *AutoshiftSummary
SetAwayFrom sets the AwayFrom field's value.
func (s *AutoshiftSummary) SetEndTime(v time.Time) *AutoshiftSummary
SetEndTime sets the EndTime field's value.
func (s *AutoshiftSummary) SetStartTime(v time.Time) *AutoshiftSummary
SetStartTime sets the StartTime field's value.
func (s *AutoshiftSummary) SetStatus(v string) *AutoshiftSummary
SetStatus sets the Status field's value.
func (s AutoshiftSummary) 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 CancelZonalShiftInput struct {
// The internally-generated identifier of a zonal shift.
//
// ZonalShiftId is a required field
ZonalShiftId *string `location:"uri" locationName:"zonalShiftId" min:"6" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s CancelZonalShiftInput) 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 *CancelZonalShiftInput) SetZonalShiftId(v string) *CancelZonalShiftInput
SetZonalShiftId sets the ZonalShiftId field's value.
func (s CancelZonalShiftInput) 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 *CancelZonalShiftInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelZonalShiftOutput struct {
// The Availability Zone that traffic is moved away from for a resource when
// you start a zonal shift. Until the zonal shift expires or you cancel it,
// traffic for the resource is instead moved to other Availability Zones in
// the Amazon Web Services Region.
//
// AwayFrom is a required field
AwayFrom *string `locationName:"awayFrom" type:"string" required:"true"`
// A comment that you enter about the zonal shift. Only the latest comment is
// retained; no comment history is maintained. A new comment overwrites any
// existing comment string.
//
// Comment is a required field
Comment *string `locationName:"comment" type:"string" required:"true"`
// The expiry time (expiration time) for a customer-started zonal shift. A zonal
// shift is temporary and must be set to expire when you start the zonal shift.
// You can initially set a zonal shift to expire in a maximum of three days
// (72 hours). However, you can update a zonal shift to set a new expiration
// at any time.
//
// When you start a zonal shift, you specify how long you want it to be active,
// which Route 53 ARC converts to an expiry time (expiration time). You can
// cancel a zonal shift when you're ready to restore traffic to the Availability
// Zone, or just wait for it to expire. Or you can update the zonal shift to
// specify another length of time to expire in.
//
// ExpiryTime is a required field
ExpiryTime *time.Time `locationName:"expiryTime" type:"timestamp" required:"true"`
// The identifier for the resource to shift away traffic for. The identifier
// is the Amazon Resource Name (ARN) for the resource.
//
// At this time, supported resources are Network Load Balancers and Application
// Load Balancers with cross-zone load balancing turned off.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// The time (UTC) when the zonal shift starts.
//
// StartTime is a required field
StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`
// A status for a zonal shift.
//
// The Status for a zonal shift can have one of the following values:
//
// * ACTIVE: The zonal shift has been started and active.
//
// * EXPIRED: The zonal shift has expired (the expiry time was exceeded).
//
// * CANCELED: The zonal shift was canceled.
//
// Status is a required field
Status *string `locationName:"status" type:"string" required:"true" enum:"ZonalShiftStatus"`
// The identifier of a zonal shift.
//
// ZonalShiftId is a required field
ZonalShiftId *string `locationName:"zonalShiftId" min:"6" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s CancelZonalShiftOutput) 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 *CancelZonalShiftOutput) SetAwayFrom(v string) *CancelZonalShiftOutput
SetAwayFrom sets the AwayFrom field's value.
func (s *CancelZonalShiftOutput) SetComment(v string) *CancelZonalShiftOutput
SetComment sets the Comment field's value.
func (s *CancelZonalShiftOutput) SetExpiryTime(v time.Time) *CancelZonalShiftOutput
SetExpiryTime sets the ExpiryTime field's value.
func (s *CancelZonalShiftOutput) SetResourceIdentifier(v string) *CancelZonalShiftOutput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s *CancelZonalShiftOutput) SetStartTime(v time.Time) *CancelZonalShiftOutput
SetStartTime sets the StartTime field's value.
func (s *CancelZonalShiftOutput) SetStatus(v string) *CancelZonalShiftOutput
SetStatus sets the Status field's value.
func (s *CancelZonalShiftOutput) SetZonalShiftId(v string) *CancelZonalShiftOutput
SetZonalShiftId sets the ZonalShiftId field's value.
func (s CancelZonalShiftOutput) 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:"-"`
Message_ *string `locationName:"message" type:"string"`
// The reason for the conflict exception.
//
// Reason is a required field
Reason *string `locationName:"reason" type:"string" required:"true" enum:"ConflictExceptionReason"`
// The zonal shift ID associated with the conflict exception.
ZonalShiftId *string `locationName:"zonalShiftId" type:"string"`
// contains filtered or unexported fields
}
The request could not be processed because of conflict in the current state of the resource.
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 ControlCondition struct {
// The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify
// as a control condition for a practice run.
//
// AlarmIdentifier is a required field
AlarmIdentifier *string `locationName:"alarmIdentifier" min:"8" type:"string" required:"true"`
// The type of alarm specified for a practice run. The only valid value is CLOUDWATCH.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"ControlConditionType"`
// contains filtered or unexported fields
}
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.
func (s ControlCondition) 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 *ControlCondition) SetAlarmIdentifier(v string) *ControlCondition
SetAlarmIdentifier sets the AlarmIdentifier field's value.
func (s *ControlCondition) SetType(v string) *ControlCondition
SetType sets the Type field's value.
func (s ControlCondition) 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 *ControlCondition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreatePracticeRunConfigurationInput struct {
// Optionally, you can block Route 53 ARC from starting practice runs for a
// resource on specific calendar dates.
//
// The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify
// dates, that dates and times for practice runs are in UTC. Separate multiple
// blocked dates with spaces.
//
// For example, if you have an application update scheduled to launch on May
// 1, 2024, and you don't want practice runs to shift traffic away at that time,
// you could set a blocked date for 2024-05-01.
BlockedDates []*string `locationName:"blockedDates" type:"list"`
// Optionally, you can block Route 53 ARC from starting practice runs for specific
// windows of days and times.
//
// The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when
// you specify dates, that dates and times for practice runs are in UTC. Also,
// be aware of potential time adjustments that might be required for daylight
// saving time differences. Separate multiple blocked windows with spaces.
//
// For example, say you run business report summaries three days a week. For
// this scenario, you might set the following recurring days and times as blocked
// windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
BlockedWindows []*string `locationName:"blockedWindows" type:"list"`
// An Amazon CloudWatch alarm that you can specify for zonal autoshift practice
// runs. This alarm blocks Route 53 ARC from starting practice run zonal shifts,
// and ends a practice run that's in progress, when the alarm is in an ALARM
// state.
BlockingAlarms []*ControlCondition `locationName:"blockingAlarms" min:"1" type:"list"`
// The outcome alarm for practice runs is a required Amazon CloudWatch alarm
// that you specify that ends a practice run when the alarm is in an ALARM state.
//
// Configure the alarm to monitor the health of your application when traffic
// is shifted away from an Availability Zone during each weekly practice run.
// You should configure the alarm to go into an ALARM state if your application
// is impacted by the zonal shift, and you want to stop the zonal shift, to
// let traffic for the resource return to the Availability Zone.
//
// OutcomeAlarms is a required field
OutcomeAlarms []*ControlCondition `locationName:"outcomeAlarms" min:"1" type:"list" required:"true"`
// The identifier of the resource to shift away traffic for when a practice
// run starts a zonal shift. The identifier is the Amazon Resource Name (ARN)
// for the resource.
//
// At this time, supported resources are Network Load Balancers and Application
// Load Balancers with cross-zone load balancing turned off.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s CreatePracticeRunConfigurationInput) 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 *CreatePracticeRunConfigurationInput) SetBlockedDates(v []*string) *CreatePracticeRunConfigurationInput
SetBlockedDates sets the BlockedDates field's value.
func (s *CreatePracticeRunConfigurationInput) SetBlockedWindows(v []*string) *CreatePracticeRunConfigurationInput
SetBlockedWindows sets the BlockedWindows field's value.
func (s *CreatePracticeRunConfigurationInput) SetBlockingAlarms(v []*ControlCondition) *CreatePracticeRunConfigurationInput
SetBlockingAlarms sets the BlockingAlarms field's value.
func (s *CreatePracticeRunConfigurationInput) SetOutcomeAlarms(v []*ControlCondition) *CreatePracticeRunConfigurationInput
SetOutcomeAlarms sets the OutcomeAlarms field's value.
func (s *CreatePracticeRunConfigurationInput) SetResourceIdentifier(v string) *CreatePracticeRunConfigurationInput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s CreatePracticeRunConfigurationInput) 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 *CreatePracticeRunConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreatePracticeRunConfigurationOutput struct {
// The Amazon Resource Name (ARN) of the resource that you configured the practice
// run for.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"8" type:"string" required:"true"`
// The name of the resource that you configured the practice run for.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// A practice run configuration for a resource. Configurations include the outcome
// alarm that you specify for practice runs, and, optionally, a blocking alarm
// and blocking dates and windows.
//
// PracticeRunConfiguration is a required field
PracticeRunConfiguration *PracticeRunConfiguration `locationName:"practiceRunConfiguration" type:"structure" required:"true"`
// The status for zonal autoshift for a resource. When you specify the autoshift
// status as ENABLED, Amazon Web Services shifts traffic away from shifts away
// application resource traffic from an Availability Zone, on your behalf, when
// Amazon Web Services determines that there's an issue in the Availability
// Zone that could potentially affect customers.
//
// When you enable zonal autoshift, you must also configure practice runs for
// the resource.
//
// ZonalAutoshiftStatus is a required field
ZonalAutoshiftStatus *string `locationName:"zonalAutoshiftStatus" type:"string" required:"true" enum:"ZonalAutoshiftStatus"`
// contains filtered or unexported fields
}
func (s CreatePracticeRunConfigurationOutput) 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 *CreatePracticeRunConfigurationOutput) SetArn(v string) *CreatePracticeRunConfigurationOutput
SetArn sets the Arn field's value.
func (s *CreatePracticeRunConfigurationOutput) SetName(v string) *CreatePracticeRunConfigurationOutput
SetName sets the Name field's value.
func (s *CreatePracticeRunConfigurationOutput) SetPracticeRunConfiguration(v *PracticeRunConfiguration) *CreatePracticeRunConfigurationOutput
SetPracticeRunConfiguration sets the PracticeRunConfiguration field's value.
func (s *CreatePracticeRunConfigurationOutput) SetZonalAutoshiftStatus(v string) *CreatePracticeRunConfigurationOutput
SetZonalAutoshiftStatus sets the ZonalAutoshiftStatus field's value.
func (s CreatePracticeRunConfigurationOutput) 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 DeletePracticeRunConfigurationInput struct {
// The identifier for the resource that you want to delete the practice run
// configuration for. The identifier is the Amazon Resource Name (ARN) for the
// resource.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `location:"uri" locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeletePracticeRunConfigurationInput) 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 *DeletePracticeRunConfigurationInput) SetResourceIdentifier(v string) *DeletePracticeRunConfigurationInput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s DeletePracticeRunConfigurationInput) 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 *DeletePracticeRunConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeletePracticeRunConfigurationOutput struct {
// The Amazon Resource Name (ARN) of the resource that you deleted the practice
// run for.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"8" type:"string" required:"true"`
// The name of the resource that you deleted the practice run for.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// The status of zonal autoshift for the resource.
//
// ZonalAutoshiftStatus is a required field
ZonalAutoshiftStatus *string `locationName:"zonalAutoshiftStatus" type:"string" required:"true" enum:"ZonalAutoshiftStatus"`
// contains filtered or unexported fields
}
func (s DeletePracticeRunConfigurationOutput) 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 *DeletePracticeRunConfigurationOutput) SetArn(v string) *DeletePracticeRunConfigurationOutput
SetArn sets the Arn field's value.
func (s *DeletePracticeRunConfigurationOutput) SetName(v string) *DeletePracticeRunConfigurationOutput
SetName sets the Name field's value.
func (s *DeletePracticeRunConfigurationOutput) SetZonalAutoshiftStatus(v string) *DeletePracticeRunConfigurationOutput
SetZonalAutoshiftStatus sets the ZonalAutoshiftStatus field's value.
func (s DeletePracticeRunConfigurationOutput) 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 GetManagedResourceInput struct {
// The identifier for the resource to shift away traffic for. The identifier
// is the Amazon Resource Name (ARN) for the resource.
//
// At this time, supported resources are Network Load Balancers and Application
// Load Balancers with cross-zone load balancing turned off.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `location:"uri" locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetManagedResourceInput) 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 *GetManagedResourceInput) SetResourceIdentifier(v string) *GetManagedResourceInput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s GetManagedResourceInput) 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 *GetManagedResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetManagedResourceOutput struct {
// A collection of key-value pairs that indicate whether resources are active
// in Availability Zones or not. The key name is the Availability Zone where
// the resource is deployed. The value is 1 or 0.
//
// AppliedWeights is a required field
AppliedWeights map[string]*float64 `locationName:"appliedWeights" type:"map" required:"true"`
// The Amazon Resource Name (ARN) for the resource.
Arn *string `locationName:"arn" min:"8" type:"string"`
// An array of the autoshifts that are active for the resource.
Autoshifts []*AutoshiftInResource `locationName:"autoshifts" type:"list"`
// The name of the resource.
Name *string `locationName:"name" min:"1" type:"string"`
// The practice run configuration for zonal autoshift that's associated with
// the resource.
PracticeRunConfiguration *PracticeRunConfiguration `locationName:"practiceRunConfiguration" type:"structure"`
// The status for zonal autoshift for a resource. When the autoshift status
// is ENABLED, Amazon Web Services shifts traffic for a resource away from an
// Availability Zone, on your behalf, when Amazon Web Services determines that
// there's an issue in the Availability Zone that could potentially affect customers.
ZonalAutoshiftStatus *string `locationName:"zonalAutoshiftStatus" type:"string" enum:"ZonalAutoshiftStatus"`
// The zonal shifts that are currently active for a resource.
//
// ZonalShifts is a required field
ZonalShifts []*ZonalShiftInResource `locationName:"zonalShifts" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s GetManagedResourceOutput) 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 *GetManagedResourceOutput) SetAppliedWeights(v map[string]*float64) *GetManagedResourceOutput
SetAppliedWeights sets the AppliedWeights field's value.
func (s *GetManagedResourceOutput) SetArn(v string) *GetManagedResourceOutput
SetArn sets the Arn field's value.
func (s *GetManagedResourceOutput) SetAutoshifts(v []*AutoshiftInResource) *GetManagedResourceOutput
SetAutoshifts sets the Autoshifts field's value.
func (s *GetManagedResourceOutput) SetName(v string) *GetManagedResourceOutput
SetName sets the Name field's value.
func (s *GetManagedResourceOutput) SetPracticeRunConfiguration(v *PracticeRunConfiguration) *GetManagedResourceOutput
SetPracticeRunConfiguration sets the PracticeRunConfiguration field's value.
func (s *GetManagedResourceOutput) SetZonalAutoshiftStatus(v string) *GetManagedResourceOutput
SetZonalAutoshiftStatus sets the ZonalAutoshiftStatus field's value.
func (s *GetManagedResourceOutput) SetZonalShifts(v []*ZonalShiftInResource) *GetManagedResourceOutput
SetZonalShifts sets the ZonalShifts field's value.
func (s GetManagedResourceOutput) 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"`
// contains filtered or unexported fields
}
There was an internal server error.
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 ListAutoshiftsInput struct {
// The number of objects that you want to return with this call.
MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
// Specifies that you want to receive the next page of results. Valid only if
// you received a NextToken response in the previous request. If you did, it
// indicates that more output is available. Set this parameter to the value
// provided by the previous call's NextToken response to request the next page
// of results.
NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
// The status of the autoshift.
Status *string `location:"querystring" locationName:"status" type:"string" enum:"AutoshiftExecutionStatus"`
// contains filtered or unexported fields
}
func (s ListAutoshiftsInput) 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 *ListAutoshiftsInput) SetMaxResults(v int64) *ListAutoshiftsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListAutoshiftsInput) SetNextToken(v string) *ListAutoshiftsInput
SetNextToken sets the NextToken field's value.
func (s *ListAutoshiftsInput) SetStatus(v string) *ListAutoshiftsInput
SetStatus sets the Status field's value.
func (s ListAutoshiftsInput) 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 *ListAutoshiftsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListAutoshiftsOutput struct {
// The items in the response list.
Items []*AutoshiftSummary `locationName:"items" type:"list"`
// Specifies that you want to receive the next page of results. Valid only if
// you received a NextToken response in the previous request. If you did, it
// indicates that more output is available. Set this parameter to the value
// provided by the previous call's NextToken response to request the next page
// of results.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListAutoshiftsOutput) 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 *ListAutoshiftsOutput) SetItems(v []*AutoshiftSummary) *ListAutoshiftsOutput
SetItems sets the Items field's value.
func (s *ListAutoshiftsOutput) SetNextToken(v string) *ListAutoshiftsOutput
SetNextToken sets the NextToken field's value.
func (s ListAutoshiftsOutput) 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 ListManagedResourcesInput struct {
// The number of objects that you want to return with this call.
MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
// Specifies that you want to receive the next page of results. Valid only if
// you received a NextToken response in the previous request. If you did, it
// indicates that more output is available. Set this parameter to the value
// provided by the previous call's NextToken response to request the next page
// of results.
NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListManagedResourcesInput) 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 *ListManagedResourcesInput) SetMaxResults(v int64) *ListManagedResourcesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListManagedResourcesInput) SetNextToken(v string) *ListManagedResourcesInput
SetNextToken sets the NextToken field's value.
func (s ListManagedResourcesInput) 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 *ListManagedResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListManagedResourcesOutput struct {
// The items in the response list.
//
// Items is a required field
Items []*ManagedResourceSummary `locationName:"items" type:"list" required:"true"`
// Specifies that you want to receive the next page of results. Valid only if
// you received a NextToken response in the previous request. If you did, it
// indicates that more output is available. Set this parameter to the value
// provided by the previous call's NextToken response to request the next page
// of results.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListManagedResourcesOutput) 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 *ListManagedResourcesOutput) SetItems(v []*ManagedResourceSummary) *ListManagedResourcesOutput
SetItems sets the Items field's value.
func (s *ListManagedResourcesOutput) SetNextToken(v string) *ListManagedResourcesOutput
SetNextToken sets the NextToken field's value.
func (s ListManagedResourcesOutput) 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 ListZonalShiftsInput struct {
// The number of objects that you want to return with this call.
MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
// Specifies that you want to receive the next page of results. Valid only if
// you received a NextToken response in the previous request. If you did, it
// indicates that more output is available. Set this parameter to the value
// provided by the previous call's NextToken response to request the next page
// of results.
NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
// The identifier for the resource that you want to list zonal shifts for. The
// identifier is the Amazon Resource Name (ARN) for the resource.
ResourceIdentifier *string `location:"querystring" locationName:"resourceIdentifier" min:"8" type:"string"`
// A status for a zonal shift.
//
// The Status for a zonal shift can have one of the following values:
//
// * ACTIVE: The zonal shift has been started and active.
//
// * EXPIRED: The zonal shift has expired (the expiry time was exceeded).
//
// * CANCELED: The zonal shift was canceled.
Status *string `location:"querystring" locationName:"status" type:"string" enum:"ZonalShiftStatus"`
// contains filtered or unexported fields
}
func (s ListZonalShiftsInput) 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 *ListZonalShiftsInput) SetMaxResults(v int64) *ListZonalShiftsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListZonalShiftsInput) SetNextToken(v string) *ListZonalShiftsInput
SetNextToken sets the NextToken field's value.
func (s *ListZonalShiftsInput) SetResourceIdentifier(v string) *ListZonalShiftsInput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s *ListZonalShiftsInput) SetStatus(v string) *ListZonalShiftsInput
SetStatus sets the Status field's value.
func (s ListZonalShiftsInput) 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 *ListZonalShiftsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListZonalShiftsOutput struct {
// The items in the response list.
Items []*ZonalShiftSummary `locationName:"items" type:"list"`
// Specifies that you want to receive the next page of results. Valid only if
// you received a NextToken response in the previous request. If you did, it
// indicates that more output is available. Set this parameter to the value
// provided by the previous call's NextToken response to request the next page
// of results.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListZonalShiftsOutput) 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 *ListZonalShiftsOutput) SetItems(v []*ZonalShiftSummary) *ListZonalShiftsOutput
SetItems sets the Items field's value.
func (s *ListZonalShiftsOutput) SetNextToken(v string) *ListZonalShiftsOutput
SetNextToken sets the NextToken field's value.
func (s ListZonalShiftsOutput) 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 ManagedResourceSummary struct {
// A collection of key-value pairs that indicate whether resources are active
// in Availability Zones or not. The key name is the Availability Zone where
// the resource is deployed. The value is 1 or 0.
AppliedWeights map[string]*float64 `locationName:"appliedWeights" type:"map"`
// The Amazon Resource Name (ARN) for the managed resource.
Arn *string `locationName:"arn" min:"8" type:"string"`
// An array of the autoshifts that have been completed for a resource.
Autoshifts []*AutoshiftInResource `locationName:"autoshifts" type:"list"`
// The Availability Zones that a resource is deployed in.
//
// AvailabilityZones is a required field
AvailabilityZones []*string `locationName:"availabilityZones" type:"list" required:"true"`
// The name of the managed resource.
Name *string `locationName:"name" min:"1" type:"string"`
// This status tracks whether a practice run configuration exists for a resource.
// When you configure a practice run for a resource so that a practice run configuration
// exists, Route 53 ARC sets this value to ENABLED. If a you have not configured
// a practice run for the resource, or delete a practice run configuration,
// Route 53 ARC sets the value to DISABLED.
//
// Route 53 ARC updates this status; you can't set a practice run status to
// ENABLED or DISABLED.
PracticeRunStatus *string `locationName:"practiceRunStatus" type:"string" enum:"ZonalAutoshiftStatus"`
// The status of autoshift for a resource. When you configure zonal autoshift
// for a resource, you can set the value of the status to ENABLED or DISABLED.
ZonalAutoshiftStatus *string `locationName:"zonalAutoshiftStatus" type:"string" enum:"ZonalAutoshiftStatus"`
// An array of the zonal shifts for a resource.
ZonalShifts []*ZonalShiftInResource `locationName:"zonalShifts" type:"list"`
// contains filtered or unexported fields
}
A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts and autoshifts.
A managed resource is a load balancer that has been registered with Route 53 ARC by Elastic Load Balancing. You can start a zonal shift in Route 53 ARC for a managed resource to temporarily move traffic for the resource away from an Availability Zone in an Amazon Web Services Region. You can also configure zonal autoshift for a managed resource.
At this time, managed resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
func (s ManagedResourceSummary) 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 *ManagedResourceSummary) SetAppliedWeights(v map[string]*float64) *ManagedResourceSummary
SetAppliedWeights sets the AppliedWeights field's value.
func (s *ManagedResourceSummary) SetArn(v string) *ManagedResourceSummary
SetArn sets the Arn field's value.
func (s *ManagedResourceSummary) SetAutoshifts(v []*AutoshiftInResource) *ManagedResourceSummary
SetAutoshifts sets the Autoshifts field's value.
func (s *ManagedResourceSummary) SetAvailabilityZones(v []*string) *ManagedResourceSummary
SetAvailabilityZones sets the AvailabilityZones field's value.
func (s *ManagedResourceSummary) SetName(v string) *ManagedResourceSummary
SetName sets the Name field's value.
func (s *ManagedResourceSummary) SetPracticeRunStatus(v string) *ManagedResourceSummary
SetPracticeRunStatus sets the PracticeRunStatus field's value.
func (s *ManagedResourceSummary) SetZonalAutoshiftStatus(v string) *ManagedResourceSummary
SetZonalAutoshiftStatus sets the ZonalAutoshiftStatus field's value.
func (s *ManagedResourceSummary) SetZonalShifts(v []*ZonalShiftInResource) *ManagedResourceSummary
SetZonalShifts sets the ZonalShifts field's value.
func (s ManagedResourceSummary) 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 PracticeRunConfiguration struct {
// An array of one or more dates that you can specify when Amazon Web Services
// does not start practice runs for a resource.
//
// Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.
BlockedDates []*string `locationName:"blockedDates" type:"list"`
// An array of one or more windows of days and times that you can block Route
// 53 ARC from starting practice runs for a resource.
//
// Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM,
// separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.
BlockedWindows []*string `locationName:"blockedWindows" type:"list"`
// The blocking alarm for practice runs is an optional alarm that you can specify
// that blocks practice runs when the alarm is in an ALARM state.
BlockingAlarms []*ControlCondition `locationName:"blockingAlarms" min:"1" type:"list"`
// The outcome alarm for practice runs is an alarm that you specify that ends
// a practice run when the alarm is in an ALARM state.
//
// OutcomeAlarms is a required field
OutcomeAlarms []*ControlCondition `locationName:"outcomeAlarms" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run.
You can update or delete a practice run configuration. Before you delete a practice run configuration, you must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.
func (s PracticeRunConfiguration) 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 *PracticeRunConfiguration) SetBlockedDates(v []*string) *PracticeRunConfiguration
SetBlockedDates sets the BlockedDates field's value.
func (s *PracticeRunConfiguration) SetBlockedWindows(v []*string) *PracticeRunConfiguration
SetBlockedWindows sets the BlockedWindows field's value.
func (s *PracticeRunConfiguration) SetBlockingAlarms(v []*ControlCondition) *PracticeRunConfiguration
SetBlockingAlarms sets the BlockingAlarms field's value.
func (s *PracticeRunConfiguration) SetOutcomeAlarms(v []*ControlCondition) *PracticeRunConfiguration
SetOutcomeAlarms sets the OutcomeAlarms field's value.
func (s PracticeRunConfiguration) 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"`
// contains filtered or unexported fields
}
The input requested a resource 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 StartZonalShiftInput struct {
// The Availability Zone that traffic is moved away from for a resource when
// you start a zonal shift. Until the zonal shift expires or you cancel it,
// traffic for the resource is instead moved to other Availability Zones in
// the Amazon Web Services Region.
//
// AwayFrom is a required field
AwayFrom *string `locationName:"awayFrom" type:"string" required:"true"`
// A comment that you enter about the zonal shift. Only the latest comment is
// retained; no comment history is maintained. A new comment overwrites any
// existing comment string.
//
// Comment is a required field
Comment *string `locationName:"comment" type:"string" required:"true"`
// The length of time that you want a zonal shift to be active, which Route
// 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary.
// You can set a zonal shift to be active initially for up to three days (72
// hours).
//
// If you want to still keep traffic away from an Availability Zone, you can
// update the zonal shift and set a new expiration. You can also cancel a zonal
// shift, before it expires, for example, if you're ready to restore traffic
// to the Availability Zone.
//
// To set a length of time for a zonal shift to be active, specify a whole number,
// and then one of the following, with no space:
//
// * A lowercase letter m: To specify that the value is in minutes.
//
// * A lowercase letter h: To specify that the value is in hours.
//
// For example: 20h means the zonal shift expires in 20 hours. 120m means the
// zonal shift expires in 120 minutes (2 hours).
//
// ExpiresIn is a required field
ExpiresIn *string `locationName:"expiresIn" min:"2" type:"string" required:"true"`
// The identifier for the resource to shift away traffic for. The identifier
// is the Amazon Resource Name (ARN) for the resource.
//
// At this time, supported resources are Network Load Balancers and Application
// Load Balancers with cross-zone load balancing turned off.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s StartZonalShiftInput) 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 *StartZonalShiftInput) SetAwayFrom(v string) *StartZonalShiftInput
SetAwayFrom sets the AwayFrom field's value.
func (s *StartZonalShiftInput) SetComment(v string) *StartZonalShiftInput
SetComment sets the Comment field's value.
func (s *StartZonalShiftInput) SetExpiresIn(v string) *StartZonalShiftInput
SetExpiresIn sets the ExpiresIn field's value.
func (s *StartZonalShiftInput) SetResourceIdentifier(v string) *StartZonalShiftInput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s StartZonalShiftInput) 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 *StartZonalShiftInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartZonalShiftOutput struct {
// The Availability Zone that traffic is moved away from for a resource when
// you start a zonal shift. Until the zonal shift expires or you cancel it,
// traffic for the resource is instead moved to other Availability Zones in
// the Amazon Web Services Region.
//
// AwayFrom is a required field
AwayFrom *string `locationName:"awayFrom" type:"string" required:"true"`
// A comment that you enter about the zonal shift. Only the latest comment is
// retained; no comment history is maintained. A new comment overwrites any
// existing comment string.
//
// Comment is a required field
Comment *string `locationName:"comment" type:"string" required:"true"`
// The expiry time (expiration time) for a customer-started zonal shift. A zonal
// shift is temporary and must be set to expire when you start the zonal shift.
// You can initially set a zonal shift to expire in a maximum of three days
// (72 hours). However, you can update a zonal shift to set a new expiration
// at any time.
//
// When you start a zonal shift, you specify how long you want it to be active,
// which Route 53 ARC converts to an expiry time (expiration time). You can
// cancel a zonal shift when you're ready to restore traffic to the Availability
// Zone, or just wait for it to expire. Or you can update the zonal shift to
// specify another length of time to expire in.
//
// ExpiryTime is a required field
ExpiryTime *time.Time `locationName:"expiryTime" type:"timestamp" required:"true"`
// The identifier for the resource to shift away traffic for. The identifier
// is the Amazon Resource Name (ARN) for the resource.
//
// At this time, supported resources are Network Load Balancers and Application
// Load Balancers with cross-zone load balancing turned off.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// The time (UTC) when the zonal shift starts.
//
// StartTime is a required field
StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`
// A status for a zonal shift.
//
// The Status for a zonal shift can have one of the following values:
//
// * ACTIVE: The zonal shift has been started and active.
//
// * EXPIRED: The zonal shift has expired (the expiry time was exceeded).
//
// * CANCELED: The zonal shift was canceled.
//
// Status is a required field
Status *string `locationName:"status" type:"string" required:"true" enum:"ZonalShiftStatus"`
// The identifier of a zonal shift.
//
// ZonalShiftId is a required field
ZonalShiftId *string `locationName:"zonalShiftId" min:"6" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s StartZonalShiftOutput) 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 *StartZonalShiftOutput) SetAwayFrom(v string) *StartZonalShiftOutput
SetAwayFrom sets the AwayFrom field's value.
func (s *StartZonalShiftOutput) SetComment(v string) *StartZonalShiftOutput
SetComment sets the Comment field's value.
func (s *StartZonalShiftOutput) SetExpiryTime(v time.Time) *StartZonalShiftOutput
SetExpiryTime sets the ExpiryTime field's value.
func (s *StartZonalShiftOutput) SetResourceIdentifier(v string) *StartZonalShiftOutput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s *StartZonalShiftOutput) SetStartTime(v time.Time) *StartZonalShiftOutput
SetStartTime sets the StartTime field's value.
func (s *StartZonalShiftOutput) SetStatus(v string) *StartZonalShiftOutput
SetStatus sets the Status field's value.
func (s *StartZonalShiftOutput) SetZonalShiftId(v string) *StartZonalShiftOutput
SetZonalShiftId sets the ZonalShiftId field's value.
func (s StartZonalShiftOutput) 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"`
// contains filtered or unexported fields
}
The request was denied due to 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 UpdatePracticeRunConfigurationInput struct {
// Add, change, or remove blocked dates for a practice run in zonal autoshift.
//
// Optionally, you can block practice runs for specific calendar dates. The
// format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates,
// that dates and times for practice runs are in UTC. Separate multiple blocked
// dates with spaces.
//
// For example, if you have an application update scheduled to launch on May
// 1, 2024, and you don't want practice runs to shift traffic away at that time,
// you could set a blocked date for 2024-05-01.
BlockedDates []*string `locationName:"blockedDates" type:"list"`
// Add, change, or remove windows of days and times for when you can, optionally,
// block Route 53 ARC from starting a practice run for a resource.
//
// The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when
// you specify dates, that dates and times for practice runs are in UTC. Also,
// be aware of potential time adjustments that might be required for daylight
// saving time differences. Separate multiple blocked windows with spaces.
//
// For example, say you run business report summaries three days a week. For
// this scenario, you might set the following recurring days and times as blocked
// windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
BlockedWindows []*string `locationName:"blockedWindows" type:"list"`
// Add, change, or remove the Amazon CloudWatch alarm that you optionally specify
// as the blocking alarm for practice runs.
BlockingAlarms []*ControlCondition `locationName:"blockingAlarms" min:"1" type:"list"`
// Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice
// runs.
OutcomeAlarms []*ControlCondition `locationName:"outcomeAlarms" min:"1" type:"list"`
// The identifier for the resource that you want to update the practice run
// configuration for. The identifier is the Amazon Resource Name (ARN) for the
// resource.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `location:"uri" locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s UpdatePracticeRunConfigurationInput) 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 *UpdatePracticeRunConfigurationInput) SetBlockedDates(v []*string) *UpdatePracticeRunConfigurationInput
SetBlockedDates sets the BlockedDates field's value.
func (s *UpdatePracticeRunConfigurationInput) SetBlockedWindows(v []*string) *UpdatePracticeRunConfigurationInput
SetBlockedWindows sets the BlockedWindows field's value.
func (s *UpdatePracticeRunConfigurationInput) SetBlockingAlarms(v []*ControlCondition) *UpdatePracticeRunConfigurationInput
SetBlockingAlarms sets the BlockingAlarms field's value.
func (s *UpdatePracticeRunConfigurationInput) SetOutcomeAlarms(v []*ControlCondition) *UpdatePracticeRunConfigurationInput
SetOutcomeAlarms sets the OutcomeAlarms field's value.
func (s *UpdatePracticeRunConfigurationInput) SetResourceIdentifier(v string) *UpdatePracticeRunConfigurationInput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s UpdatePracticeRunConfigurationInput) 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 *UpdatePracticeRunConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdatePracticeRunConfigurationOutput struct {
// The Amazon Resource Name (ARN) of the resource that you updated the practice
// run for.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"8" type:"string" required:"true"`
// The name of the resource that you updated the practice run for.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// The practice run configuration that was updated.
//
// PracticeRunConfiguration is a required field
PracticeRunConfiguration *PracticeRunConfiguration `locationName:"practiceRunConfiguration" type:"structure" required:"true"`
// The zonal autoshift status for the resource that you updated the practice
// run for.
//
// ZonalAutoshiftStatus is a required field
ZonalAutoshiftStatus *string `locationName:"zonalAutoshiftStatus" type:"string" required:"true" enum:"ZonalAutoshiftStatus"`
// contains filtered or unexported fields
}
func (s UpdatePracticeRunConfigurationOutput) 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 *UpdatePracticeRunConfigurationOutput) SetArn(v string) *UpdatePracticeRunConfigurationOutput
SetArn sets the Arn field's value.
func (s *UpdatePracticeRunConfigurationOutput) SetName(v string) *UpdatePracticeRunConfigurationOutput
SetName sets the Name field's value.
func (s *UpdatePracticeRunConfigurationOutput) SetPracticeRunConfiguration(v *PracticeRunConfiguration) *UpdatePracticeRunConfigurationOutput
SetPracticeRunConfiguration sets the PracticeRunConfiguration field's value.
func (s *UpdatePracticeRunConfigurationOutput) SetZonalAutoshiftStatus(v string) *UpdatePracticeRunConfigurationOutput
SetZonalAutoshiftStatus sets the ZonalAutoshiftStatus field's value.
func (s UpdatePracticeRunConfigurationOutput) 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 UpdateZonalAutoshiftConfigurationInput struct {
// The identifier for the resource that you want to update the zonal autoshift
// configuration for. The identifier is the Amazon Resource Name (ARN) for the
// resource.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `location:"uri" locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// The zonal autoshift status for the resource that you want to update the zonal
// autoshift configuration for.
//
// ZonalAutoshiftStatus is a required field
ZonalAutoshiftStatus *string `locationName:"zonalAutoshiftStatus" type:"string" required:"true" enum:"ZonalAutoshiftStatus"`
// contains filtered or unexported fields
}
func (s UpdateZonalAutoshiftConfigurationInput) 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 *UpdateZonalAutoshiftConfigurationInput) SetResourceIdentifier(v string) *UpdateZonalAutoshiftConfigurationInput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s *UpdateZonalAutoshiftConfigurationInput) SetZonalAutoshiftStatus(v string) *UpdateZonalAutoshiftConfigurationInput
SetZonalAutoshiftStatus sets the ZonalAutoshiftStatus field's value.
func (s UpdateZonalAutoshiftConfigurationInput) 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 *UpdateZonalAutoshiftConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateZonalAutoshiftConfigurationOutput struct {
// The identifier for the resource that you updated the zonal autoshift configuration
// for. The identifier is the Amazon Resource Name (ARN) for the resource.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// The zonal autoshift status for the resource that you updated the zonal autoshift
// configuration for.
//
// ZonalAutoshiftStatus is a required field
ZonalAutoshiftStatus *string `locationName:"zonalAutoshiftStatus" type:"string" required:"true" enum:"ZonalAutoshiftStatus"`
// contains filtered or unexported fields
}
func (s UpdateZonalAutoshiftConfigurationOutput) 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 *UpdateZonalAutoshiftConfigurationOutput) SetResourceIdentifier(v string) *UpdateZonalAutoshiftConfigurationOutput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s *UpdateZonalAutoshiftConfigurationOutput) SetZonalAutoshiftStatus(v string) *UpdateZonalAutoshiftConfigurationOutput
SetZonalAutoshiftStatus sets the ZonalAutoshiftStatus field's value.
func (s UpdateZonalAutoshiftConfigurationOutput) 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 UpdateZonalShiftInput struct {
// A comment that you enter about the zonal shift. Only the latest comment is
// retained; no comment history is maintained. A new comment overwrites any
// existing comment string.
Comment *string `locationName:"comment" type:"string"`
// The length of time that you want a zonal shift to be active, which Route
// 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary.
// You can set a zonal shift to be active initially for up to three days (72
// hours).
//
// If you want to still keep traffic away from an Availability Zone, you can
// update the zonal shift and set a new expiration. You can also cancel a zonal
// shift, before it expires, for example, if you're ready to restore traffic
// to the Availability Zone.
//
// To set a length of time for a zonal shift to be active, specify a whole number,
// and then one of the following, with no space:
//
// * A lowercase letter m: To specify that the value is in minutes.
//
// * A lowercase letter h: To specify that the value is in hours.
//
// For example: 20h means the zonal shift expires in 20 hours. 120m means the
// zonal shift expires in 120 minutes (2 hours).
ExpiresIn *string `locationName:"expiresIn" min:"2" type:"string"`
// The identifier of a zonal shift.
//
// ZonalShiftId is a required field
ZonalShiftId *string `location:"uri" locationName:"zonalShiftId" min:"6" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s UpdateZonalShiftInput) 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 *UpdateZonalShiftInput) SetComment(v string) *UpdateZonalShiftInput
SetComment sets the Comment field's value.
func (s *UpdateZonalShiftInput) SetExpiresIn(v string) *UpdateZonalShiftInput
SetExpiresIn sets the ExpiresIn field's value.
func (s *UpdateZonalShiftInput) SetZonalShiftId(v string) *UpdateZonalShiftInput
SetZonalShiftId sets the ZonalShiftId field's value.
func (s UpdateZonalShiftInput) 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 *UpdateZonalShiftInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateZonalShiftOutput struct {
// The Availability Zone that traffic is moved away from for a resource when
// you start a zonal shift. Until the zonal shift expires or you cancel it,
// traffic for the resource is instead moved to other Availability Zones in
// the Amazon Web Services Region.
//
// AwayFrom is a required field
AwayFrom *string `locationName:"awayFrom" type:"string" required:"true"`
// A comment that you enter about the zonal shift. Only the latest comment is
// retained; no comment history is maintained. A new comment overwrites any
// existing comment string.
//
// Comment is a required field
Comment *string `locationName:"comment" type:"string" required:"true"`
// The expiry time (expiration time) for a customer-started zonal shift. A zonal
// shift is temporary and must be set to expire when you start the zonal shift.
// You can initially set a zonal shift to expire in a maximum of three days
// (72 hours). However, you can update a zonal shift to set a new expiration
// at any time.
//
// When you start a zonal shift, you specify how long you want it to be active,
// which Route 53 ARC converts to an expiry time (expiration time). You can
// cancel a zonal shift when you're ready to restore traffic to the Availability
// Zone, or just wait for it to expire. Or you can update the zonal shift to
// specify another length of time to expire in.
//
// ExpiryTime is a required field
ExpiryTime *time.Time `locationName:"expiryTime" type:"timestamp" required:"true"`
// The identifier for the resource to shift away traffic for. The identifier
// is the Amazon Resource Name (ARN) for the resource.
//
// At this time, supported resources are Network Load Balancers and Application
// Load Balancers with cross-zone load balancing turned off.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// The time (UTC) when the zonal shift starts.
//
// StartTime is a required field
StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`
// A status for a zonal shift.
//
// The Status for a zonal shift can have one of the following values:
//
// * ACTIVE: The zonal shift has been started and active.
//
// * EXPIRED: The zonal shift has expired (the expiry time was exceeded).
//
// * CANCELED: The zonal shift was canceled.
//
// Status is a required field
Status *string `locationName:"status" type:"string" required:"true" enum:"ZonalShiftStatus"`
// The identifier of a zonal shift.
//
// ZonalShiftId is a required field
ZonalShiftId *string `locationName:"zonalShiftId" min:"6" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s UpdateZonalShiftOutput) 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 *UpdateZonalShiftOutput) SetAwayFrom(v string) *UpdateZonalShiftOutput
SetAwayFrom sets the AwayFrom field's value.
func (s *UpdateZonalShiftOutput) SetComment(v string) *UpdateZonalShiftOutput
SetComment sets the Comment field's value.
func (s *UpdateZonalShiftOutput) SetExpiryTime(v time.Time) *UpdateZonalShiftOutput
SetExpiryTime sets the ExpiryTime field's value.
func (s *UpdateZonalShiftOutput) SetResourceIdentifier(v string) *UpdateZonalShiftOutput
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s *UpdateZonalShiftOutput) SetStartTime(v time.Time) *UpdateZonalShiftOutput
SetStartTime sets the StartTime field's value.
func (s *UpdateZonalShiftOutput) SetStatus(v string) *UpdateZonalShiftOutput
SetStatus sets the Status field's value.
func (s *UpdateZonalShiftOutput) SetZonalShiftId(v string) *UpdateZonalShiftOutput
SetZonalShiftId sets the ZonalShiftId field's value.
func (s UpdateZonalShiftOutput) 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:"-"`
Message_ *string `locationName:"message" type:"string"`
// The reason for the validation exception.
//
// Reason is a required field
Reason *string `locationName:"reason" type:"string" required:"true" enum:"ValidationExceptionReason"`
// contains filtered or unexported fields
}
The input fails to satisfy the constraints specified by an Amazon Web Services service.
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 ZonalShiftInResource struct {
// The appliedStatus field specifies which application traffic shift is in effect
// for a resource when there is more than one traffic shift active. There can
// be more than one application traffic shift in progress at the same time -
// that is, practice run zonal shifts, customer-started zonal shifts, or an
// autoshift. The appliedStatus field for an autoshift for a resource can have
// one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that
// is currently in effect for the resource has an applied status set to APPLIED.
//
// The overall principle for precedence is that zonal shifts that you start
// as a customer take precedence autoshifts, which take precedence over practice
// runs. That is, customer-started zonal shifts > autoshifts > practice run
// zonal shifts.
//
// For more information, see How zonal autoshift and practice runs work (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html)
// in the Amazon Route 53 Application Recovery Controller Developer Guide.
//
// AppliedStatus is a required field
AppliedStatus *string `locationName:"appliedStatus" type:"string" required:"true" enum:"AppliedStatus"`
// The Availability Zone that traffic is moved away from for a resource when
// you start a zonal shift. Until the zonal shift expires or you cancel it,
// traffic for the resource is instead moved to other Availability Zones in
// the Amazon Web Services Region.
//
// AwayFrom is a required field
AwayFrom *string `locationName:"awayFrom" type:"string" required:"true"`
// A comment that you enter about the zonal shift. Only the latest comment is
// retained; no comment history is maintained. That is, a new comment overwrites
// any existing comment string.
//
// Comment is a required field
Comment *string `locationName:"comment" type:"string" required:"true"`
// The expiry time (expiration time) for a customer-started zonal shift. A zonal
// shift is temporary and must be set to expire when you start the zonal shift.
// You can initially set a zonal shift to expire in a maximum of three days
// (72 hours). However, you can update a zonal shift to set a new expiration
// at any time.
//
// When you start a zonal shift, you specify how long you want it to be active,
// which Route 53 ARC converts to an expiry time (expiration time). You can
// cancel a zonal shift when you're ready to restore traffic to the Availability
// Zone, or just wait for it to expire. Or you can update the zonal shift to
// specify another length of time to expire in.
//
// ExpiryTime is a required field
ExpiryTime *time.Time `locationName:"expiryTime" type:"timestamp" required:"true"`
// The outcome, or end state, returned for a practice run. The following values
// can be returned:
//
// * PENDING: Outcome value when a practice run is in progress.
//
// * SUCCEEDED: Outcome value when the outcome alarm specified for the practice
// run configuration does not go into an ALARM state during the practice
// run, and the practice run was not interrupted before it completed the
// expected 30 minute zonal shift.
//
// * INTERRUPTED: Outcome value when the practice run was stopped before
// the expected 30 minute zonal shift duration, or there was another problem
// with the practice run that created an inconclusive outcome.
//
// * FAILED: Outcome value when the outcome alarm specified for the practice
// run configuration goes into an ALARM state during the practice run, and
// the practice run was not interrupted before it completed.
//
// For more information about practice run outcomes, see Considerations when
// you configure zonal autoshift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html)
// in the Amazon Route 53 Application Recovery Controller Developer Guide.
PracticeRunOutcome *string `locationName:"practiceRunOutcome" type:"string" enum:"PracticeRunOutcome"`
// The identifier for the resource to include in a zonal shift. The identifier
// is the Amazon Resource Name (ARN) for the resource.
//
// At this time, you can only start a zonal shift for Network Load Balancers
// and Application Load Balancers with cross-zone load balancing turned off.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// The time (UTC) when the zonal shift starts.
//
// StartTime is a required field
StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`
// The identifier of a zonal shift.
//
// ZonalShiftId is a required field
ZonalShiftId *string `locationName:"zonalShiftId" min:"6" type:"string" required:"true"`
// contains filtered or unexported fields
}
A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.
func (s ZonalShiftInResource) 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 *ZonalShiftInResource) SetAppliedStatus(v string) *ZonalShiftInResource
SetAppliedStatus sets the AppliedStatus field's value.
func (s *ZonalShiftInResource) SetAwayFrom(v string) *ZonalShiftInResource
SetAwayFrom sets the AwayFrom field's value.
func (s *ZonalShiftInResource) SetComment(v string) *ZonalShiftInResource
SetComment sets the Comment field's value.
func (s *ZonalShiftInResource) SetExpiryTime(v time.Time) *ZonalShiftInResource
SetExpiryTime sets the ExpiryTime field's value.
func (s *ZonalShiftInResource) SetPracticeRunOutcome(v string) *ZonalShiftInResource
SetPracticeRunOutcome sets the PracticeRunOutcome field's value.
func (s *ZonalShiftInResource) SetResourceIdentifier(v string) *ZonalShiftInResource
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s *ZonalShiftInResource) SetStartTime(v time.Time) *ZonalShiftInResource
SetStartTime sets the StartTime field's value.
func (s *ZonalShiftInResource) SetZonalShiftId(v string) *ZonalShiftInResource
SetZonalShiftId sets the ZonalShiftId field's value.
func (s ZonalShiftInResource) 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 ZonalShiftSummary struct {
// The Availability Zone that traffic is moved away from for a resource when
// you start a zonal shift. Until the zonal shift expires or you cancel it,
// traffic for the resource is instead moved to other Availability Zones in
// the Amazon Web Services Region.
//
// AwayFrom is a required field
AwayFrom *string `locationName:"awayFrom" type:"string" required:"true"`
// A comment that you enter about the zonal shift. Only the latest comment is
// retained; no comment history is maintained. That is, a new comment overwrites
// any existing comment string.
//
// Comment is a required field
Comment *string `locationName:"comment" type:"string" required:"true"`
// The expiry time (expiration time) for a customer-started zonal shift. A zonal
// shift is temporary and must be set to expire when you start the zonal shift.
// You can initially set a zonal shift to expire in a maximum of three days
// (72 hours). However, you can update a zonal shift to set a new expiration
// at any time.
//
// When you start a zonal shift, you specify how long you want it to be active,
// which Route 53 ARC converts to an expiry time (expiration time). You can
// cancel a zonal shift when you're ready to restore traffic to the Availability
// Zone, or just wait for it to expire. Or you can update the zonal shift to
// specify another length of time to expire in.
//
// ExpiryTime is a required field
ExpiryTime *time.Time `locationName:"expiryTime" type:"timestamp" required:"true"`
// The outcome, or end state, of a practice run. The following values can be
// returned:
//
// * PENDING: Outcome value when the practice run is in progress.
//
// * SUCCEEDED: Outcome value when the outcome alarm specified for the practice
// run configuration does not go into an ALARM state during the practice
// run, and the practice run was not interrupted before it completed.
//
// * INTERRUPTED: Outcome value when the practice run did not run for the
// expected 30 minutes or there was another problem with the practice run
// that created an inconclusive outcome.
//
// * FAILED: Outcome value when the outcome alarm specified for the practice
// run configuration goes into an ALARM state during the practice run, and
// the practice run was not interrupted before it completed.
//
// For more information about practice run outcomes, see Considerations when
// you configure zonal autoshift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html)
// in the Amazon Route 53 Application Recovery Controller Developer Guide.
PracticeRunOutcome *string `locationName:"practiceRunOutcome" type:"string" enum:"PracticeRunOutcome"`
// The identifier for the resource to include in a zonal shift. The identifier
// is the Amazon Resource Name (ARN) for the resource.
//
// At this time, you can only start a zonal shift for Network Load Balancers
// and Application Load Balancers with cross-zone load balancing turned off.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
// The time (UTC) when the zonal shift starts.
//
// StartTime is a required field
StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`
// A status for a zonal shift.
//
// The Status for a zonal shift can have one of the following values:
//
// * ACTIVE: The zonal shift has been started and active.
//
// * EXPIRED: The zonal shift has expired (the expiry time was exceeded).
//
// * CANCELED: The zonal shift was canceled.
//
// Status is a required field
Status *string `locationName:"status" type:"string" required:"true" enum:"ZonalShiftStatus"`
// The identifier of a zonal shift.
//
// ZonalShiftId is a required field
ZonalShiftId *string `locationName:"zonalShiftId" min:"6" type:"string" required:"true"`
// contains filtered or unexported fields
}
Lists information about zonal shifts in Amazon Route 53 Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that Route 53 ARC starts on your behalf for practice runs with zonal autoshift.
Zonal shifts are temporary, including customer-started zonal shifts and the zonal autoshift practice run zonal shifts that Route 53 ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A practice run zonal shift has a 30 minute duration.
func (s ZonalShiftSummary) 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 *ZonalShiftSummary) SetAwayFrom(v string) *ZonalShiftSummary
SetAwayFrom sets the AwayFrom field's value.
func (s *ZonalShiftSummary) SetComment(v string) *ZonalShiftSummary
SetComment sets the Comment field's value.
func (s *ZonalShiftSummary) SetExpiryTime(v time.Time) *ZonalShiftSummary
SetExpiryTime sets the ExpiryTime field's value.
func (s *ZonalShiftSummary) SetPracticeRunOutcome(v string) *ZonalShiftSummary
SetPracticeRunOutcome sets the PracticeRunOutcome field's value.
func (s *ZonalShiftSummary) SetResourceIdentifier(v string) *ZonalShiftSummary
SetResourceIdentifier sets the ResourceIdentifier field's value.
func (s *ZonalShiftSummary) SetStartTime(v time.Time) *ZonalShiftSummary
SetStartTime sets the StartTime field's value.
func (s *ZonalShiftSummary) SetStatus(v string) *ZonalShiftSummary
SetStatus sets the Status field's value.
func (s *ZonalShiftSummary) SetZonalShiftId(v string) *ZonalShiftSummary
SetZonalShiftId sets the ZonalShiftId field's value.
func (s ZonalShiftSummary) 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".