arczonalshift

package
v1.48.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package arczonalshift provides the client and types for making API requests to AWS ARC - Zonal Shift.

This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about zonal shift API actions, data types, and errors.

Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.

Zonal shift in Route 53 ARC enables you to move traffic for a load balancer resource away from an Availability Zone. Starting a zonal shift helps your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone, reducing the impact and time lost from an issue in one zone.

Supported AWS resources are automatically registered with Route 53 ARC. Resources that are registered for zonal shifts in Route 53 ARC are managed resources in Route 53 ARC. You can start a zonal shift for any managed resource in your account in a Region. 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.

Zonal shifts are temporary. You must specify an expiration when you start a zonal shift, of up to three days initially. 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.

For more information about using zonal shift, see the Amazon Route 53 Application Recovery Controller Developer Guide (https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html).

See https://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30 for more information on this service.

See arczonalshift package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/arczonalshift/

Using the Client

To contact AWS ARC - Zonal Shift with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS ARC - Zonal Shift client ARCZonalShift for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/arczonalshift/#New

Index

Constants

View Source 
const (
	// AppliedStatusApplied is a AppliedStatus enum value
	AppliedStatusApplied = "APPLIED"

	// AppliedStatusNotApplied is a AppliedStatus enum value
	AppliedStatusNotApplied = "NOT_APPLIED"
)
View Source 
const (
	// ConflictExceptionReasonZonalShiftAlreadyExists is a ConflictExceptionReason enum value
	ConflictExceptionReasonZonalShiftAlreadyExists = "ZonalShiftAlreadyExists"

	// ConflictExceptionReasonZonalShiftStatusNotActive is a ConflictExceptionReason enum value
	ConflictExceptionReasonZonalShiftStatusNotActive = "ZonalShiftStatusNotActive"

	// ConflictExceptionReasonSimultaneousZonalShiftsConflict is a ConflictExceptionReason enum value
	ConflictExceptionReasonSimultaneousZonalShiftsConflict = "SimultaneousZonalShiftsConflict"
)
View Source 
const (
	// ValidationExceptionReasonInvalidExpiresIn is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidExpiresIn = "InvalidExpiresIn"

	// ValidationExceptionReasonInvalidStatus is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidStatus = "InvalidStatus"

	// ValidationExceptionReasonMissingValue is a ValidationExceptionReason enum value
	ValidationExceptionReasonMissingValue = "MissingValue"

	// ValidationExceptionReasonInvalidToken is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidToken = "InvalidToken"

	// ValidationExceptionReasonInvalidResourceIdentifier is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidResourceIdentifier = "InvalidResourceIdentifier"

	// ValidationExceptionReasonInvalidAz is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidAz = "InvalidAz"

	// ValidationExceptionReasonUnsupportedAz is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnsupportedAz = "UnsupportedAz"
)
View Source 
const (
	// ZonalShiftStatusActive is a ZonalShiftStatus enum value
	ZonalShiftStatusActive = "ACTIVE"

	// ZonalShiftStatusExpired is a ZonalShiftStatus enum value
	ZonalShiftStatusExpired = "EXPIRED"

	// ZonalShiftStatusCanceled is a ZonalShiftStatus enum value
	ZonalShiftStatusCanceled = "CANCELED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request could not be processed because of conflict in the current state
	// of the resource.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// There was an internal server error.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The input requested a resource that was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by an AWS service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "ARC Zonal Shift" // Name of service.
	EndpointsID = "arc-zonal-shift" // ID to lookup a service endpoint with.
	ServiceID   = "ARC Zonal Shift" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AppliedStatus_Values 

func AppliedStatus_Values() []string

AppliedStatus_Values returns all elements of the AppliedStatus enum

func ConflictExceptionReason_Values 

func ConflictExceptionReason_Values() []string

ConflictExceptionReason_Values returns all elements of the ConflictExceptionReason enum

func ValidationExceptionReason_Values 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

func ZonalShiftStatus_Values 

func ZonalShiftStatus_Values() []string

ZonalShiftStatus_Values returns all elements of the ZonalShiftStatus enum

Types

type ARCZonalShift 

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 

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 (*ARCZonalShift) CancelZonalShift 

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 that you've started for a resource in your AWS account in an AWS Region.

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 AWS 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 (*ARCZonalShift) CancelZonalShiftRequest 

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 (*ARCZonalShift) CancelZonalShiftWithContext 

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 (*ARCZonalShift) GetManagedResource 

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 AWS Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC.

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.

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 AWS 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 (*ARCZonalShift) GetManagedResourceRequest 

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 (*ARCZonalShift) GetManagedResourceWithContext 

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 (*ARCZonalShift) ListManagedResources 

func (c *ARCZonalShift) ListManagedResources(input *ListManagedResourcesInput) (*ListManagedResourcesOutput, error)

ListManagedResources API operation for AWS ARC - Zonal Shift.

Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are 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 AWS 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 (*ARCZonalShift) ListManagedResourcesPages 

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 (*ARCZonalShift) ListManagedResourcesPagesWithContext 

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 (*ARCZonalShift) ListManagedResourcesRequest 

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 (*ARCZonalShift) ListManagedResourcesWithContext 

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 (*ARCZonalShift) ListZonalShifts 

func (c *ARCZonalShift) ListZonalShifts(input *ListZonalShiftsInput) (*ListZonalShiftsOutput, error)

ListZonalShifts API operation for AWS ARC - Zonal Shift.

Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

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 AWS 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 (*ARCZonalShift) ListZonalShiftsPages 

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 (*ARCZonalShift) ListZonalShiftsPagesWithContext 

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 (*ARCZonalShift) ListZonalShiftsRequest 

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 (*ARCZonalShift) ListZonalShiftsWithContext 

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 (*ARCZonalShift) StartZonalShift 

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 a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your account in an AWS Region. Resources are automatically registered with Route 53 ARC by AWS 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 AWS 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 (*ARCZonalShift) StartZonalShiftRequest 

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 (*ARCZonalShift) StartZonalShiftWithContext 

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 (*ARCZonalShift) UpdateZonalShift 

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 AWS 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 AWS 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 (*ARCZonalShift) UpdateZonalShiftRequest 

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 (*ARCZonalShift) UpdateZonalShiftWithContext 

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 

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 (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

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 (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

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 CancelZonalShiftInput 

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 (CancelZonalShiftInput) GoString 

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 (*CancelZonalShiftInput) SetZonalShiftId 

func (s *CancelZonalShiftInput) SetZonalShiftId(v string) *CancelZonalShiftInput

SetZonalShiftId sets the ZonalShiftId field's value.

func (CancelZonalShiftInput) String 

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 (*CancelZonalShiftInput) Validate 

func (s *CancelZonalShiftInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelZonalShiftOutput 

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 AWS 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 the 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, for example, if you're ready to restore traffic to
	// the Availability Zone. 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 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 is started.
	//
	// 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 is 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 (CancelZonalShiftOutput) GoString 

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 (*CancelZonalShiftOutput) SetAwayFrom 

func (s *CancelZonalShiftOutput) SetAwayFrom(v string) *CancelZonalShiftOutput

SetAwayFrom sets the AwayFrom field's value.

func (*CancelZonalShiftOutput) SetComment 

func (s *CancelZonalShiftOutput) SetComment(v string) *CancelZonalShiftOutput

SetComment sets the Comment field's value.

func (*CancelZonalShiftOutput) SetExpiryTime 

func (s *CancelZonalShiftOutput) SetExpiryTime(v time.Time) *CancelZonalShiftOutput

SetExpiryTime sets the ExpiryTime field's value.

func (*CancelZonalShiftOutput) SetResourceIdentifier 

func (s *CancelZonalShiftOutput) SetResourceIdentifier(v string) *CancelZonalShiftOutput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*CancelZonalShiftOutput) SetStartTime 

func (s *CancelZonalShiftOutput) SetStartTime(v time.Time) *CancelZonalShiftOutput

SetStartTime sets the StartTime field's value.

func (*CancelZonalShiftOutput) SetStatus 

func (s *CancelZonalShiftOutput) SetStatus(v string) *CancelZonalShiftOutput

SetStatus sets the Status field's value.

func (*CancelZonalShiftOutput) SetZonalShiftId 

func (s *CancelZonalShiftOutput) SetZonalShiftId(v string) *CancelZonalShiftOutput

SetZonalShiftId sets the ZonalShiftId field's value.

func (CancelZonalShiftOutput) String 

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 

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 (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

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 (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

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 GetManagedResourceInput 

type GetManagedResourceInput struct {

	// 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 `location:"uri" locationName:"resourceIdentifier" min:"8" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetManagedResourceInput) GoString 

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 (*GetManagedResourceInput) SetResourceIdentifier 

func (s *GetManagedResourceInput) SetResourceIdentifier(v string) *GetManagedResourceInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (GetManagedResourceInput) String 

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 (*GetManagedResourceInput) Validate 

func (s *GetManagedResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetManagedResourceOutput 

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"`

	// The name of the resource.
	Name *string `locationName:"name" min:"1" type:"string"`

	// 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 (GetManagedResourceOutput) GoString 

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 (*GetManagedResourceOutput) SetAppliedWeights 

func (s *GetManagedResourceOutput) SetAppliedWeights(v map[string]*float64) *GetManagedResourceOutput

SetAppliedWeights sets the AppliedWeights field's value.

func (*GetManagedResourceOutput) SetArn 

func (s *GetManagedResourceOutput) SetArn(v string) *GetManagedResourceOutput

SetArn sets the Arn field's value.

func (*GetManagedResourceOutput) SetName 

func (s *GetManagedResourceOutput) SetName(v string) *GetManagedResourceOutput

SetName sets the Name field's value.

func (*GetManagedResourceOutput) SetZonalShifts 

func (s *GetManagedResourceOutput) SetZonalShifts(v []*ZonalShiftInResource) *GetManagedResourceOutput

SetZonalShifts sets the ZonalShifts field's value.

func (GetManagedResourceOutput) String 

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 

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 (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

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 (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

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 ListManagedResourcesInput 

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 (ListManagedResourcesInput) GoString 

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 (*ListManagedResourcesInput) SetMaxResults 

func (s *ListManagedResourcesInput) SetMaxResults(v int64) *ListManagedResourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListManagedResourcesInput) SetNextToken 

func (s *ListManagedResourcesInput) SetNextToken(v string) *ListManagedResourcesInput

SetNextToken sets the NextToken field's value.

func (ListManagedResourcesInput) String 

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 (*ListManagedResourcesInput) Validate 

func (s *ListManagedResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListManagedResourcesOutput 

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 (ListManagedResourcesOutput) GoString 

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 (*ListManagedResourcesOutput) SetItems 

func (s *ListManagedResourcesOutput) SetItems(v []*ManagedResourceSummary) *ListManagedResourcesOutput

SetItems sets the Items field's value.

func (*ListManagedResourcesOutput) SetNextToken 

func (s *ListManagedResourcesOutput) SetNextToken(v string) *ListManagedResourcesOutput

SetNextToken sets the NextToken field's value.

func (ListManagedResourcesOutput) String 

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 

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"`

	// A status for a zonal shift.
	//
	// The Status for a zonal shift can have one of the following values:
	//
	//    * ACTIVE: The zonal shift is 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 (ListZonalShiftsInput) GoString 

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 (*ListZonalShiftsInput) SetMaxResults 

func (s *ListZonalShiftsInput) SetMaxResults(v int64) *ListZonalShiftsInput

SetMaxResults sets the MaxResults field's value.

func (*ListZonalShiftsInput) SetNextToken 

func (s *ListZonalShiftsInput) SetNextToken(v string) *ListZonalShiftsInput

SetNextToken sets the NextToken field's value.

func (*ListZonalShiftsInput) SetStatus 

func (s *ListZonalShiftsInput) SetStatus(v string) *ListZonalShiftsInput

SetStatus sets the Status field's value.

func (ListZonalShiftsInput) String 

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 (*ListZonalShiftsInput) Validate 

func (s *ListZonalShiftsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListZonalShiftsOutput 

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 (ListZonalShiftsOutput) GoString 

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 (*ListZonalShiftsOutput) SetItems 

func (s *ListZonalShiftsOutput) SetItems(v []*ZonalShiftSummary) *ListZonalShiftsOutput

SetItems sets the Items field's value.

func (*ListZonalShiftsOutput) SetNextToken 

func (s *ListZonalShiftsOutput) SetNextToken(v string) *ListZonalShiftsOutput

SetNextToken sets the NextToken field's value.

func (ListZonalShiftsOutput) String 

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 

type ManagedResourceSummary struct {

	// The Amazon Resource Name (ARN) for the managed resource.
	Arn *string `locationName:"arn" min:"8" type:"string"`

	// 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"`
	// contains filtered or unexported fields
}

A complex structure for a managed resource in an account.

A managed resource is a Network Load Balancer or Application 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 AWS Region.

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.

func (ManagedResourceSummary) GoString 

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 (*ManagedResourceSummary) SetArn 

func (s *ManagedResourceSummary) SetArn(v string) *ManagedResourceSummary

SetArn sets the Arn field's value.

func (*ManagedResourceSummary) SetAvailabilityZones 

func (s *ManagedResourceSummary) SetAvailabilityZones(v []*string) *ManagedResourceSummary

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*ManagedResourceSummary) SetName 

func (s *ManagedResourceSummary) SetName(v string) *ManagedResourceSummary

SetName sets the Name field's value.

func (ManagedResourceSummary) String 

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 ResourceNotFoundException 

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 (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

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 (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

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 

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 AWS 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:
	//
	//    <ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is
	//    in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify
	//    that the value is in hours.</p> </li> </ul> <p>For example: <code>20h</code>
	//    means the zonal shift expires in 20 hours. <code>120m</code> means the
	//    zonal shift expires in 120 minutes (2 hours).</p>
	//
	// ExpiresIn is a required field
	ExpiresIn *string `locationName:"expiresIn" min:"2" type:"string" required:"true"`

	// 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"`
	// contains filtered or unexported fields
}

func (StartZonalShiftInput) GoString 

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 (*StartZonalShiftInput) SetAwayFrom 

func (s *StartZonalShiftInput) SetAwayFrom(v string) *StartZonalShiftInput

SetAwayFrom sets the AwayFrom field's value.

func (*StartZonalShiftInput) SetComment 

func (s *StartZonalShiftInput) SetComment(v string) *StartZonalShiftInput

SetComment sets the Comment field's value.

func (*StartZonalShiftInput) SetExpiresIn 

func (s *StartZonalShiftInput) SetExpiresIn(v string) *StartZonalShiftInput

SetExpiresIn sets the ExpiresIn field's value.

func (*StartZonalShiftInput) SetResourceIdentifier 

func (s *StartZonalShiftInput) SetResourceIdentifier(v string) *StartZonalShiftInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (StartZonalShiftInput) String 

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 (*StartZonalShiftInput) Validate 

func (s *StartZonalShiftInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartZonalShiftOutput 

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 AWS 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 the 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, for example, if you're ready to restore traffic to
	// the Availability Zone. 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 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 is started.
	//
	// 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 is 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 (StartZonalShiftOutput) GoString 

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 (*StartZonalShiftOutput) SetAwayFrom 

func (s *StartZonalShiftOutput) SetAwayFrom(v string) *StartZonalShiftOutput

SetAwayFrom sets the AwayFrom field's value.

func (*StartZonalShiftOutput) SetComment 

func (s *StartZonalShiftOutput) SetComment(v string) *StartZonalShiftOutput

SetComment sets the Comment field's value.

func (*StartZonalShiftOutput) SetExpiryTime 

func (s *StartZonalShiftOutput) SetExpiryTime(v time.Time) *StartZonalShiftOutput

SetExpiryTime sets the ExpiryTime field's value.

func (*StartZonalShiftOutput) SetResourceIdentifier 

func (s *StartZonalShiftOutput) SetResourceIdentifier(v string) *StartZonalShiftOutput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*StartZonalShiftOutput) SetStartTime 

func (s *StartZonalShiftOutput) SetStartTime(v time.Time) *StartZonalShiftOutput

SetStartTime sets the StartTime field's value.

func (*StartZonalShiftOutput) SetStatus 

func (s *StartZonalShiftOutput) SetStatus(v string) *StartZonalShiftOutput

SetStatus sets the Status field's value.

func (*StartZonalShiftOutput) SetZonalShiftId 

func (s *StartZonalShiftOutput) SetZonalShiftId(v string) *StartZonalShiftOutput

SetZonalShiftId sets the ZonalShiftId field's value.

func (StartZonalShiftOutput) String 

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 

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 (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

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 (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

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 UpdateZonalShiftInput 

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 (UpdateZonalShiftInput) GoString 

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 (*UpdateZonalShiftInput) SetComment 

func (s *UpdateZonalShiftInput) SetComment(v string) *UpdateZonalShiftInput

SetComment sets the Comment field's value.

func (*UpdateZonalShiftInput) SetExpiresIn 

func (s *UpdateZonalShiftInput) SetExpiresIn(v string) *UpdateZonalShiftInput

SetExpiresIn sets the ExpiresIn field's value.

func (*UpdateZonalShiftInput) SetZonalShiftId 

func (s *UpdateZonalShiftInput) SetZonalShiftId(v string) *UpdateZonalShiftInput

SetZonalShiftId sets the ZonalShiftId field's value.

func (UpdateZonalShiftInput) String 

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 (*UpdateZonalShiftInput) Validate 

func (s *UpdateZonalShiftInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateZonalShiftOutput 

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 AWS 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 the 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, for example, if you're ready to restore traffic to
	// the Availability Zone. 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 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 is started.
	//
	// 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 is 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 (UpdateZonalShiftOutput) GoString 

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 (*UpdateZonalShiftOutput) SetAwayFrom 

func (s *UpdateZonalShiftOutput) SetAwayFrom(v string) *UpdateZonalShiftOutput

SetAwayFrom sets the AwayFrom field's value.

func (*UpdateZonalShiftOutput) SetComment 

func (s *UpdateZonalShiftOutput) SetComment(v string) *UpdateZonalShiftOutput

SetComment sets the Comment field's value.

func (*UpdateZonalShiftOutput) SetExpiryTime 

func (s *UpdateZonalShiftOutput) SetExpiryTime(v time.Time) *UpdateZonalShiftOutput

SetExpiryTime sets the ExpiryTime field's value.

func (*UpdateZonalShiftOutput) SetResourceIdentifier 

func (s *UpdateZonalShiftOutput) SetResourceIdentifier(v string) *UpdateZonalShiftOutput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*UpdateZonalShiftOutput) SetStartTime 

func (s *UpdateZonalShiftOutput) SetStartTime(v time.Time) *UpdateZonalShiftOutput

SetStartTime sets the StartTime field's value.

func (*UpdateZonalShiftOutput) SetStatus 

func (s *UpdateZonalShiftOutput) SetStatus(v string) *UpdateZonalShiftOutput

SetStatus sets the Status field's value.

func (*UpdateZonalShiftOutput) SetZonalShiftId 

func (s *UpdateZonalShiftOutput) SetZonalShiftId(v string) *UpdateZonalShiftOutput

SetZonalShiftId sets the ZonalShiftId field's value.

func (UpdateZonalShiftOutput) String 

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 

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 AWS service.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

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 (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

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 

type ZonalShiftInResource struct {

	// An appliedStatus for a zonal shift for a resource can have one of two values:
	// APPLIED or NOT_APPLIED.
	//
	// 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 AWS 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 the 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, for example, if you're ready to restore traffic to
	// the Availability Zone. 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 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 is started.
	//
	// 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 (ZonalShiftInResource) GoString 

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 (*ZonalShiftInResource) SetAppliedStatus 

func (s *ZonalShiftInResource) SetAppliedStatus(v string) *ZonalShiftInResource

SetAppliedStatus sets the AppliedStatus field's value.

func (*ZonalShiftInResource) SetAwayFrom 

func (s *ZonalShiftInResource) SetAwayFrom(v string) *ZonalShiftInResource

SetAwayFrom sets the AwayFrom field's value.

func (*ZonalShiftInResource) SetComment 

func (s *ZonalShiftInResource) SetComment(v string) *ZonalShiftInResource

SetComment sets the Comment field's value.

func (*ZonalShiftInResource) SetExpiryTime 

func (s *ZonalShiftInResource) SetExpiryTime(v time.Time) *ZonalShiftInResource

SetExpiryTime sets the ExpiryTime field's value.

func (*ZonalShiftInResource) SetResourceIdentifier 

func (s *ZonalShiftInResource) SetResourceIdentifier(v string) *ZonalShiftInResource

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*ZonalShiftInResource) SetStartTime 

func (s *ZonalShiftInResource) SetStartTime(v time.Time) *ZonalShiftInResource

SetStartTime sets the StartTime field's value.

func (*ZonalShiftInResource) SetZonalShiftId 

func (s *ZonalShiftInResource) SetZonalShiftId(v string) *ZonalShiftInResource

SetZonalShiftId sets the ZonalShiftId field's value.

func (ZonalShiftInResource) String 

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 

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 AWS 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 the 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, for example, if you're ready to restore traffic to
	// the Availability Zone. 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 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 is started.
	//
	// 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 is 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
}

You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region. A zonal shift helps your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your account in an AWS Region. Supported AWS resources are automatically registered with Route 53 ARC.

Zonal shifts are temporary. A zonal shift can be active for up to three days (72 hours).

When you start a zonal shift, you specify how long you want it to be active, which Amazon Route 53 Application Recovery Controller converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you're ready to restore traffic to the Availability Zone. Or you can extend the zonal shift by updating the expiration so the zonal shift is active longer.

func (ZonalShiftSummary) GoString 

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 (*ZonalShiftSummary) SetAwayFrom 

func (s *ZonalShiftSummary) SetAwayFrom(v string) *ZonalShiftSummary

SetAwayFrom sets the AwayFrom field's value.

func (*ZonalShiftSummary) SetComment 

func (s *ZonalShiftSummary) SetComment(v string) *ZonalShiftSummary

SetComment sets the Comment field's value.

func (*ZonalShiftSummary) SetExpiryTime 

func (s *ZonalShiftSummary) SetExpiryTime(v time.Time) *ZonalShiftSummary

SetExpiryTime sets the ExpiryTime field's value.

func (*ZonalShiftSummary) SetResourceIdentifier 

func (s *ZonalShiftSummary) SetResourceIdentifier(v string) *ZonalShiftSummary

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*ZonalShiftSummary) SetStartTime 

func (s *ZonalShiftSummary) SetStartTime(v time.Time) *ZonalShiftSummary

SetStartTime sets the StartTime field's value.

func (*ZonalShiftSummary) SetStatus 

func (s *ZonalShiftSummary) SetStatus(v string) *ZonalShiftSummary

SetStatus sets the Status field's value.

func (*ZonalShiftSummary) SetZonalShiftId 

func (s *ZonalShiftSummary) SetZonalShiftId(v string) *ZonalShiftSummary

SetZonalShiftId sets the ZonalShiftId field's value.

func (ZonalShiftSummary) String 

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".

Source Files

View all Source files

Directories

Path Synopsis
Package arczonalshiftiface provides an interface to enable mocking the AWS ARC - Zonal Shift service client for testing your code.
 Package arczonalshiftiface provides an interface to enable mocking the AWS ARC - Zonal Shift service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.