route53recoveryreadiness

package module
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Aug 19, 2021 License: Apache-2.0 Imports: 29 Imported by: 11

Documentation

Overview

Package route53recoveryreadiness provides the API client, operations, and parameter types for AWS Route53 Recovery Readiness.

AWS Route53 Recovery Readiness

Index

Constants

View Source
const ServiceAPIVersion = "2019-12-02"
View Source
const ServiceID = "Route53 Recovery Readiness"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Route53 Recovery Readiness.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateCell

func (c *Client) CreateCell(ctx context.Context, params *CreateCellInput, optFns ...func(*Options)) (*CreateCellOutput, error)

Creates a new Cell.

func (*Client) CreateCrossAccountAuthorization

func (c *Client) CreateCrossAccountAuthorization(ctx context.Context, params *CreateCrossAccountAuthorizationInput, optFns ...func(*Options)) (*CreateCrossAccountAuthorizationOutput, error)

Create a new cross account readiness authorization.

func (*Client) CreateReadinessCheck

func (c *Client) CreateReadinessCheck(ctx context.Context, params *CreateReadinessCheckInput, optFns ...func(*Options)) (*CreateReadinessCheckOutput, error)

Creates a new Readiness Check.

func (*Client) CreateRecoveryGroup

func (c *Client) CreateRecoveryGroup(ctx context.Context, params *CreateRecoveryGroupInput, optFns ...func(*Options)) (*CreateRecoveryGroupOutput, error)

Creates a new Recovery Group.

func (*Client) CreateResourceSet

func (c *Client) CreateResourceSet(ctx context.Context, params *CreateResourceSetInput, optFns ...func(*Options)) (*CreateResourceSetOutput, error)

Creates a new Resource Set.

func (*Client) DeleteCell

func (c *Client) DeleteCell(ctx context.Context, params *DeleteCellInput, optFns ...func(*Options)) (*DeleteCellOutput, error)

Deletes an existing Cell.

func (*Client) DeleteCrossAccountAuthorization

func (c *Client) DeleteCrossAccountAuthorization(ctx context.Context, params *DeleteCrossAccountAuthorizationInput, optFns ...func(*Options)) (*DeleteCrossAccountAuthorizationOutput, error)

Delete cross account readiness authorization

func (*Client) DeleteReadinessCheck

func (c *Client) DeleteReadinessCheck(ctx context.Context, params *DeleteReadinessCheckInput, optFns ...func(*Options)) (*DeleteReadinessCheckOutput, error)

Deletes an existing Readiness Check.

func (*Client) DeleteRecoveryGroup

func (c *Client) DeleteRecoveryGroup(ctx context.Context, params *DeleteRecoveryGroupInput, optFns ...func(*Options)) (*DeleteRecoveryGroupOutput, error)

Deletes an existing Recovery Group.

func (*Client) DeleteResourceSet

func (c *Client) DeleteResourceSet(ctx context.Context, params *DeleteResourceSetInput, optFns ...func(*Options)) (*DeleteResourceSetOutput, error)

Deletes an existing Resource Set.

func (*Client) GetArchitectureRecommendations

func (c *Client) GetArchitectureRecommendations(ctx context.Context, params *GetArchitectureRecommendationsInput, optFns ...func(*Options)) (*GetArchitectureRecommendationsOutput, error)

Returns a collection of recommendations to improve resilliance and readiness check quality for a Recovery Group.

func (*Client) GetCell

func (c *Client) GetCell(ctx context.Context, params *GetCellInput, optFns ...func(*Options)) (*GetCellOutput, error)

Returns information about a Cell.

func (*Client) GetCellReadinessSummary

func (c *Client) GetCellReadinessSummary(ctx context.Context, params *GetCellReadinessSummaryInput, optFns ...func(*Options)) (*GetCellReadinessSummaryOutput, error)

Returns information about readiness of a Cell.

func (*Client) GetReadinessCheck

func (c *Client) GetReadinessCheck(ctx context.Context, params *GetReadinessCheckInput, optFns ...func(*Options)) (*GetReadinessCheckOutput, error)

Returns information about a ReadinessCheck.

func (*Client) GetReadinessCheckResourceStatus

func (c *Client) GetReadinessCheckResourceStatus(ctx context.Context, params *GetReadinessCheckResourceStatusInput, optFns ...func(*Options)) (*GetReadinessCheckResourceStatusOutput, error)

Returns detailed information about the status of an individual resource within a Readiness Check's Resource Set.

func (*Client) GetReadinessCheckStatus

func (c *Client) GetReadinessCheckStatus(ctx context.Context, params *GetReadinessCheckStatusInput, optFns ...func(*Options)) (*GetReadinessCheckStatusOutput, error)

Returns information about the status of a Readiness Check.

func (*Client) GetRecoveryGroup

func (c *Client) GetRecoveryGroup(ctx context.Context, params *GetRecoveryGroupInput, optFns ...func(*Options)) (*GetRecoveryGroupOutput, error)

Returns information about a Recovery Group.

func (*Client) GetRecoveryGroupReadinessSummary

func (c *Client) GetRecoveryGroupReadinessSummary(ctx context.Context, params *GetRecoveryGroupReadinessSummaryInput, optFns ...func(*Options)) (*GetRecoveryGroupReadinessSummaryOutput, error)

Returns information about a Recovery Group.

func (*Client) GetResourceSet

func (c *Client) GetResourceSet(ctx context.Context, params *GetResourceSetInput, optFns ...func(*Options)) (*GetResourceSetOutput, error)

Returns information about a Resource Set.

func (*Client) ListCells

func (c *Client) ListCells(ctx context.Context, params *ListCellsInput, optFns ...func(*Options)) (*ListCellsOutput, error)

Returns a collection of Cells.

func (*Client) ListCrossAccountAuthorizations

func (c *Client) ListCrossAccountAuthorizations(ctx context.Context, params *ListCrossAccountAuthorizationsInput, optFns ...func(*Options)) (*ListCrossAccountAuthorizationsOutput, error)

Returns a collection of cross account readiness authorizations.

func (*Client) ListReadinessChecks

func (c *Client) ListReadinessChecks(ctx context.Context, params *ListReadinessChecksInput, optFns ...func(*Options)) (*ListReadinessChecksOutput, error)

Returns a collection of Readiness Checks.

func (*Client) ListRecoveryGroups

func (c *Client) ListRecoveryGroups(ctx context.Context, params *ListRecoveryGroupsInput, optFns ...func(*Options)) (*ListRecoveryGroupsOutput, error)

Returns a collection of Recovery Groups.

func (*Client) ListResourceSets

func (c *Client) ListResourceSets(ctx context.Context, params *ListResourceSetsInput, optFns ...func(*Options)) (*ListResourceSetsOutput, error)

Returns a collection of Resource Sets.

func (*Client) ListRules

func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns ...func(*Options)) (*ListRulesOutput, error)

Returns a collection of rules that are applied as part of Readiness Checks.

func (*Client) ListTagsForResources

func (c *Client) ListTagsForResources(ctx context.Context, params *ListTagsForResourcesInput, optFns ...func(*Options)) (*ListTagsForResourcesOutput, error)

Returns a list of the tags assigned to the specified resource.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds tags to the specified resource. You can specify one or more tags to add.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from the specified resource. You can specify one or more tags to remove.

func (*Client) UpdateCell

func (c *Client) UpdateCell(ctx context.Context, params *UpdateCellInput, optFns ...func(*Options)) (*UpdateCellOutput, error)

Updates an existing Cell.

func (*Client) UpdateReadinessCheck

func (c *Client) UpdateReadinessCheck(ctx context.Context, params *UpdateReadinessCheckInput, optFns ...func(*Options)) (*UpdateReadinessCheckOutput, error)

Updates an exisiting Readiness Check.

func (*Client) UpdateRecoveryGroup

func (c *Client) UpdateRecoveryGroup(ctx context.Context, params *UpdateRecoveryGroupInput, optFns ...func(*Options)) (*UpdateRecoveryGroupOutput, error)

Updates an existing Recovery Group.

func (*Client) UpdateResourceSet

func (c *Client) UpdateResourceSet(ctx context.Context, params *UpdateResourceSetInput, optFns ...func(*Options)) (*UpdateResourceSetOutput, error)

Updates an existing Resource Set.

type CreateCellInput

type CreateCellInput struct {

	// The name of the Cell to create
	//
	// This member is required.
	CellName *string

	// A list of Cell arns contained within this Cell (for use in nested Cells, e.g.
	// regions within which AZs)
	Cells []string

	// A collection of tags associated with a resource
	Tags map[string]string
	// contains filtered or unexported fields
}

The Cell to create

type CreateCellOutput

type CreateCellOutput struct {

	// The arn for the Cell
	CellArn *string

	// The name of the Cell
	CellName *string

	// A list of Cell arns
	Cells []string

	// A list of Cell ARNs and/or RecoveryGroup ARNs
	ParentReadinessScopes []string

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCrossAccountAuthorizationInput

type CreateCrossAccountAuthorizationInput struct {

	// The cross account authorization
	//
	// This member is required.
	CrossAccountAuthorization *string
	// contains filtered or unexported fields
}

The cross account authorization

type CreateCrossAccountAuthorizationOutput

type CreateCrossAccountAuthorizationOutput struct {

	// The cross account authorization
	CrossAccountAuthorization *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateReadinessCheckInput

type CreateReadinessCheckInput struct {

	// The name of the ReadinessCheck to create
	//
	// This member is required.
	ReadinessCheckName *string

	// The name of the ResourceSet to check
	//
	// This member is required.
	ResourceSetName *string

	// A collection of tags associated with a resource
	Tags map[string]string
	// contains filtered or unexported fields
}

The ReadinessCheck to create

type CreateReadinessCheckOutput

type CreateReadinessCheckOutput struct {

	// Arn associated with ReadinessCheck
	ReadinessCheckArn *string

	// Name for a ReadinessCheck
	ReadinessCheckName *string

	// Name of the ResourceSet to be checked
	ResourceSet *string

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRecoveryGroupInput

type CreateRecoveryGroupInput struct {

	// The name of the RecoveryGroup to create
	//
	// This member is required.
	RecoveryGroupName *string

	// A list of Cell arns
	Cells []string

	// A collection of tags associated with a resource
	Tags map[string]string
	// contains filtered or unexported fields
}

The RecoveryGroup to create

type CreateRecoveryGroupOutput

type CreateRecoveryGroupOutput struct {

	// A list of Cell arns
	Cells []string

	// The arn for the RecoveryGroup
	RecoveryGroupArn *string

	// The name of the RecoveryGroup
	RecoveryGroupName *string

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateResourceSetInput

type CreateResourceSetInput struct {

	// The name of the ResourceSet to create
	//
	// This member is required.
	ResourceSetName *string

	// AWS Resource type of the resources in the ResourceSet
	//
	// This member is required.
	ResourceSetType *string

	// A list of Resource objects
	//
	// This member is required.
	Resources []types.Resource

	// A collection of tags associated with a resource
	Tags map[string]string
	// contains filtered or unexported fields
}

The ResourceSet to create

type CreateResourceSetOutput

type CreateResourceSetOutput struct {

	// The arn for the ResourceSet
	ResourceSetArn *string

	// The name of the ResourceSet
	ResourceSetName *string

	// AWS Resource Type of the resources in the ResourceSet
	ResourceSetType *string

	// A list of Resource objects
	Resources []types.Resource

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCellInput

type DeleteCellInput struct {

	// The Cell to delete
	//
	// This member is required.
	CellName *string
	// contains filtered or unexported fields
}

type DeleteCellOutput

type DeleteCellOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCrossAccountAuthorizationInput

type DeleteCrossAccountAuthorizationInput struct {

	// The cross account authorization
	//
	// This member is required.
	CrossAccountAuthorization *string
	// contains filtered or unexported fields
}

type DeleteCrossAccountAuthorizationOutput

type DeleteCrossAccountAuthorizationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteReadinessCheckInput

type DeleteReadinessCheckInput struct {

	// The ReadinessCheck to delete
	//
	// This member is required.
	ReadinessCheckName *string
	// contains filtered or unexported fields
}

type DeleteReadinessCheckOutput

type DeleteReadinessCheckOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRecoveryGroupInput

type DeleteRecoveryGroupInput struct {

	// The RecoveryGroup to delete
	//
	// This member is required.
	RecoveryGroupName *string
	// contains filtered or unexported fields
}

type DeleteRecoveryGroupOutput

type DeleteRecoveryGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourceSetInput

type DeleteResourceSetInput struct {

	// The ResourceSet to delete
	//
	// This member is required.
	ResourceSetName *string
	// contains filtered or unexported fields
}

type DeleteResourceSetOutput

type DeleteResourceSetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetArchitectureRecommendationsInput

type GetArchitectureRecommendationsInput struct {

	// Name of RecoveryGroup (top level resource) to be analyzed.
	//
	// This member is required.
	RecoveryGroupName *string

	// Upper bound on number of records to return.
	MaxResults int32

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string
	// contains filtered or unexported fields
}

type GetArchitectureRecommendationsOutput

type GetArchitectureRecommendationsOutput struct {

	// The time a Recovery Group was last assessed for recommendations in UTC ISO-8601
	// format.
	LastAuditTimestamp *time.Time

	// A token that can be used to resume pagination from the end of the collection
	NextToken *string

	// A list of recommendations for the customer's application
	Recommendations []types.Recommendation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCellInput

type GetCellInput struct {

	// The Cell to get
	//
	// This member is required.
	CellName *string
	// contains filtered or unexported fields
}

type GetCellOutput

type GetCellOutput struct {

	// The arn for the Cell
	CellArn *string

	// The name of the Cell
	CellName *string

	// A list of Cell arns
	Cells []string

	// A list of Cell ARNs and/or RecoveryGroup ARNs
	ParentReadinessScopes []string

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCellReadinessSummaryAPIClient

type GetCellReadinessSummaryAPIClient interface {
	GetCellReadinessSummary(context.Context, *GetCellReadinessSummaryInput, ...func(*Options)) (*GetCellReadinessSummaryOutput, error)
}

GetCellReadinessSummaryAPIClient is a client that implements the GetCellReadinessSummary operation.

type GetCellReadinessSummaryInput

type GetCellReadinessSummaryInput struct {

	// The name of the Cell
	//
	// This member is required.
	CellName *string

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type GetCellReadinessSummaryOutput

type GetCellReadinessSummaryOutput struct {

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// The readiness at Cell level.
	Readiness types.Readiness

	// Summaries for the ReadinessChecks making up the Cell
	ReadinessChecks []types.ReadinessCheckSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCellReadinessSummaryPaginator

type GetCellReadinessSummaryPaginator struct {
	// contains filtered or unexported fields
}

GetCellReadinessSummaryPaginator is a paginator for GetCellReadinessSummary

func NewGetCellReadinessSummaryPaginator

NewGetCellReadinessSummaryPaginator returns a new GetCellReadinessSummaryPaginator

func (*GetCellReadinessSummaryPaginator) HasMorePages

func (p *GetCellReadinessSummaryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetCellReadinessSummaryPaginator) NextPage

NextPage retrieves the next GetCellReadinessSummary page.

type GetCellReadinessSummaryPaginatorOptions

type GetCellReadinessSummaryPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetCellReadinessSummaryPaginatorOptions is the paginator options for GetCellReadinessSummary

type GetReadinessCheckInput

type GetReadinessCheckInput struct {

	// The ReadinessCheck to get
	//
	// This member is required.
	ReadinessCheckName *string
	// contains filtered or unexported fields
}

type GetReadinessCheckOutput

type GetReadinessCheckOutput struct {

	// Arn associated with ReadinessCheck
	ReadinessCheckArn *string

	// Name for a ReadinessCheck
	ReadinessCheckName *string

	// Name of the ResourceSet to be checked
	ResourceSet *string

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReadinessCheckResourceStatusAPIClient

type GetReadinessCheckResourceStatusAPIClient interface {
	GetReadinessCheckResourceStatus(context.Context, *GetReadinessCheckResourceStatusInput, ...func(*Options)) (*GetReadinessCheckResourceStatusOutput, error)
}

GetReadinessCheckResourceStatusAPIClient is a client that implements the GetReadinessCheckResourceStatus operation.

type GetReadinessCheckResourceStatusInput

type GetReadinessCheckResourceStatusInput struct {

	// The ReadinessCheck to get
	//
	// This member is required.
	ReadinessCheckName *string

	// The resource ARN or component Id to get
	//
	// This member is required.
	ResourceIdentifier *string

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type GetReadinessCheckResourceStatusOutput

type GetReadinessCheckResourceStatusOutput struct {

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// The readiness at rule level.
	Readiness types.Readiness

	// Details of the rules's results
	Rules []types.RuleResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReadinessCheckResourceStatusPaginator

type GetReadinessCheckResourceStatusPaginator struct {
	// contains filtered or unexported fields
}

GetReadinessCheckResourceStatusPaginator is a paginator for GetReadinessCheckResourceStatus

func NewGetReadinessCheckResourceStatusPaginator

NewGetReadinessCheckResourceStatusPaginator returns a new GetReadinessCheckResourceStatusPaginator

func (*GetReadinessCheckResourceStatusPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*GetReadinessCheckResourceStatusPaginator) NextPage

NextPage retrieves the next GetReadinessCheckResourceStatus page.

type GetReadinessCheckResourceStatusPaginatorOptions

type GetReadinessCheckResourceStatusPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetReadinessCheckResourceStatusPaginatorOptions is the paginator options for GetReadinessCheckResourceStatus

type GetReadinessCheckStatusAPIClient

type GetReadinessCheckStatusAPIClient interface {
	GetReadinessCheckStatus(context.Context, *GetReadinessCheckStatusInput, ...func(*Options)) (*GetReadinessCheckStatusOutput, error)
}

GetReadinessCheckStatusAPIClient is a client that implements the GetReadinessCheckStatus operation.

type GetReadinessCheckStatusInput

type GetReadinessCheckStatusInput struct {

	// The ReadinessCheck to get
	//
	// This member is required.
	ReadinessCheckName *string

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type GetReadinessCheckStatusOutput

type GetReadinessCheckStatusOutput struct {

	// Top level messages for readiness check status
	Messages []types.Message

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// The readiness at rule level.
	Readiness types.Readiness

	// Summary of resources's readiness
	Resources []types.ResourceResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReadinessCheckStatusPaginator

type GetReadinessCheckStatusPaginator struct {
	// contains filtered or unexported fields
}

GetReadinessCheckStatusPaginator is a paginator for GetReadinessCheckStatus

func NewGetReadinessCheckStatusPaginator

NewGetReadinessCheckStatusPaginator returns a new GetReadinessCheckStatusPaginator

func (*GetReadinessCheckStatusPaginator) HasMorePages

func (p *GetReadinessCheckStatusPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetReadinessCheckStatusPaginator) NextPage

NextPage retrieves the next GetReadinessCheckStatus page.

type GetReadinessCheckStatusPaginatorOptions

type GetReadinessCheckStatusPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetReadinessCheckStatusPaginatorOptions is the paginator options for GetReadinessCheckStatus

type GetRecoveryGroupInput

type GetRecoveryGroupInput struct {

	// The RecoveryGroup to get
	//
	// This member is required.
	RecoveryGroupName *string
	// contains filtered or unexported fields
}

type GetRecoveryGroupOutput

type GetRecoveryGroupOutput struct {

	// A list of Cell arns
	Cells []string

	// The arn for the RecoveryGroup
	RecoveryGroupArn *string

	// The name of the RecoveryGroup
	RecoveryGroupName *string

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRecoveryGroupReadinessSummaryAPIClient

type GetRecoveryGroupReadinessSummaryAPIClient interface {
	GetRecoveryGroupReadinessSummary(context.Context, *GetRecoveryGroupReadinessSummaryInput, ...func(*Options)) (*GetRecoveryGroupReadinessSummaryOutput, error)
}

GetRecoveryGroupReadinessSummaryAPIClient is a client that implements the GetRecoveryGroupReadinessSummary operation.

type GetRecoveryGroupReadinessSummaryInput

type GetRecoveryGroupReadinessSummaryInput struct {

	// The name of the RecoveryGroup
	//
	// This member is required.
	RecoveryGroupName *string

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type GetRecoveryGroupReadinessSummaryOutput

type GetRecoveryGroupReadinessSummaryOutput struct {

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// The readiness at RecoveryGroup level.
	Readiness types.Readiness

	// Summaries for the ReadinessChecks making up the RecoveryGroup
	ReadinessChecks []types.ReadinessCheckSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRecoveryGroupReadinessSummaryPaginator

type GetRecoveryGroupReadinessSummaryPaginator struct {
	// contains filtered or unexported fields
}

GetRecoveryGroupReadinessSummaryPaginator is a paginator for GetRecoveryGroupReadinessSummary

func NewGetRecoveryGroupReadinessSummaryPaginator

NewGetRecoveryGroupReadinessSummaryPaginator returns a new GetRecoveryGroupReadinessSummaryPaginator

func (*GetRecoveryGroupReadinessSummaryPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*GetRecoveryGroupReadinessSummaryPaginator) NextPage

NextPage retrieves the next GetRecoveryGroupReadinessSummary page.

type GetRecoveryGroupReadinessSummaryPaginatorOptions

type GetRecoveryGroupReadinessSummaryPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetRecoveryGroupReadinessSummaryPaginatorOptions is the paginator options for GetRecoveryGroupReadinessSummary

type GetResourceSetInput

type GetResourceSetInput struct {

	// The ResourceSet to get
	//
	// This member is required.
	ResourceSetName *string
	// contains filtered or unexported fields
}

type GetResourceSetOutput

type GetResourceSetOutput struct {

	// The arn for the ResourceSet
	ResourceSetArn *string

	// The name of the ResourceSet
	ResourceSetName *string

	// AWS Resource Type of the resources in the ResourceSet
	ResourceSetType *string

	// A list of Resource objects
	Resources []types.Resource

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListCellsAPIClient

type ListCellsAPIClient interface {
	ListCells(context.Context, *ListCellsInput, ...func(*Options)) (*ListCellsOutput, error)
}

ListCellsAPIClient is a client that implements the ListCells operation.

type ListCellsInput

type ListCellsInput struct {

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCellsOutput

type ListCellsOutput struct {

	// A list of Cells
	Cells []types.CellOutput

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCellsPaginator

type ListCellsPaginator struct {
	// contains filtered or unexported fields
}

ListCellsPaginator is a paginator for ListCells

func NewListCellsPaginator

func NewListCellsPaginator(client ListCellsAPIClient, params *ListCellsInput, optFns ...func(*ListCellsPaginatorOptions)) *ListCellsPaginator

NewListCellsPaginator returns a new ListCellsPaginator

func (*ListCellsPaginator) HasMorePages

func (p *ListCellsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCellsPaginator) NextPage

func (p *ListCellsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCellsOutput, error)

NextPage retrieves the next ListCells page.

type ListCellsPaginatorOptions

type ListCellsPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCellsPaginatorOptions is the paginator options for ListCells

type ListCrossAccountAuthorizationsAPIClient

type ListCrossAccountAuthorizationsAPIClient interface {
	ListCrossAccountAuthorizations(context.Context, *ListCrossAccountAuthorizationsInput, ...func(*Options)) (*ListCrossAccountAuthorizationsOutput, error)
}

ListCrossAccountAuthorizationsAPIClient is a client that implements the ListCrossAccountAuthorizations operation.

type ListCrossAccountAuthorizationsInput

type ListCrossAccountAuthorizationsInput struct {

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCrossAccountAuthorizationsOutput

type ListCrossAccountAuthorizationsOutput struct {

	// A list of CrossAccountAuthorizations
	CrossAccountAuthorizations []string

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCrossAccountAuthorizationsPaginator

type ListCrossAccountAuthorizationsPaginator struct {
	// contains filtered or unexported fields
}

ListCrossAccountAuthorizationsPaginator is a paginator for ListCrossAccountAuthorizations

func NewListCrossAccountAuthorizationsPaginator

NewListCrossAccountAuthorizationsPaginator returns a new ListCrossAccountAuthorizationsPaginator

func (*ListCrossAccountAuthorizationsPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCrossAccountAuthorizationsPaginator) NextPage

NextPage retrieves the next ListCrossAccountAuthorizations page.

type ListCrossAccountAuthorizationsPaginatorOptions

type ListCrossAccountAuthorizationsPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCrossAccountAuthorizationsPaginatorOptions is the paginator options for ListCrossAccountAuthorizations

type ListReadinessChecksAPIClient

type ListReadinessChecksAPIClient interface {
	ListReadinessChecks(context.Context, *ListReadinessChecksInput, ...func(*Options)) (*ListReadinessChecksOutput, error)
}

ListReadinessChecksAPIClient is a client that implements the ListReadinessChecks operation.

type ListReadinessChecksInput

type ListReadinessChecksInput struct {

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReadinessChecksOutput

type ListReadinessChecksOutput struct {

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// A list of ReadinessCheck associated with the account
	ReadinessChecks []types.ReadinessCheckOutput

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReadinessChecksPaginator

type ListReadinessChecksPaginator struct {
	// contains filtered or unexported fields
}

ListReadinessChecksPaginator is a paginator for ListReadinessChecks

func NewListReadinessChecksPaginator

func NewListReadinessChecksPaginator(client ListReadinessChecksAPIClient, params *ListReadinessChecksInput, optFns ...func(*ListReadinessChecksPaginatorOptions)) *ListReadinessChecksPaginator

NewListReadinessChecksPaginator returns a new ListReadinessChecksPaginator

func (*ListReadinessChecksPaginator) HasMorePages

func (p *ListReadinessChecksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReadinessChecksPaginator) NextPage

func (p *ListReadinessChecksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReadinessChecksOutput, error)

NextPage retrieves the next ListReadinessChecks page.

type ListReadinessChecksPaginatorOptions

type ListReadinessChecksPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReadinessChecksPaginatorOptions is the paginator options for ListReadinessChecks

type ListRecoveryGroupsAPIClient

type ListRecoveryGroupsAPIClient interface {
	ListRecoveryGroups(context.Context, *ListRecoveryGroupsInput, ...func(*Options)) (*ListRecoveryGroupsOutput, error)
}

ListRecoveryGroupsAPIClient is a client that implements the ListRecoveryGroups operation.

type ListRecoveryGroupsInput

type ListRecoveryGroupsInput struct {

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRecoveryGroupsOutput

type ListRecoveryGroupsOutput struct {

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// A list of RecoveryGroups
	RecoveryGroups []types.RecoveryGroupOutput

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRecoveryGroupsPaginator

type ListRecoveryGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListRecoveryGroupsPaginator is a paginator for ListRecoveryGroups

func NewListRecoveryGroupsPaginator

func NewListRecoveryGroupsPaginator(client ListRecoveryGroupsAPIClient, params *ListRecoveryGroupsInput, optFns ...func(*ListRecoveryGroupsPaginatorOptions)) *ListRecoveryGroupsPaginator

NewListRecoveryGroupsPaginator returns a new ListRecoveryGroupsPaginator

func (*ListRecoveryGroupsPaginator) HasMorePages

func (p *ListRecoveryGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecoveryGroupsPaginator) NextPage

func (p *ListRecoveryGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecoveryGroupsOutput, error)

NextPage retrieves the next ListRecoveryGroups page.

type ListRecoveryGroupsPaginatorOptions

type ListRecoveryGroupsPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRecoveryGroupsPaginatorOptions is the paginator options for ListRecoveryGroups

type ListResourceSetsAPIClient

type ListResourceSetsAPIClient interface {
	ListResourceSets(context.Context, *ListResourceSetsInput, ...func(*Options)) (*ListResourceSetsOutput, error)
}

ListResourceSetsAPIClient is a client that implements the ListResourceSets operation.

type ListResourceSetsInput

type ListResourceSetsInput struct {

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourceSetsOutput

type ListResourceSetsOutput struct {

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// A list of ResourceSets associated with the account
	ResourceSets []types.ResourceSetOutput

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourceSetsPaginator

type ListResourceSetsPaginator struct {
	// contains filtered or unexported fields
}

ListResourceSetsPaginator is a paginator for ListResourceSets

func NewListResourceSetsPaginator

func NewListResourceSetsPaginator(client ListResourceSetsAPIClient, params *ListResourceSetsInput, optFns ...func(*ListResourceSetsPaginatorOptions)) *ListResourceSetsPaginator

NewListResourceSetsPaginator returns a new ListResourceSetsPaginator

func (*ListResourceSetsPaginator) HasMorePages

func (p *ListResourceSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourceSetsPaginator) NextPage

func (p *ListResourceSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceSetsOutput, error)

NextPage retrieves the next ListResourceSets page.

type ListResourceSetsPaginatorOptions

type ListResourceSetsPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourceSetsPaginatorOptions is the paginator options for ListResourceSets

type ListRulesAPIClient

type ListRulesAPIClient interface {
	ListRules(context.Context, *ListRulesInput, ...func(*Options)) (*ListRulesOutput, error)
}

ListRulesAPIClient is a client that implements the ListRules operation.

type ListRulesInput

type ListRulesInput struct {

	// Upper bound on number of records to return.
	MaxResults int32

	// A token used to resume pagination from the end of a previous request.
	NextToken *string

	// Filter parameter which specifies the rules to return given a resource type.
	ResourceType *string
	// contains filtered or unexported fields
}

type ListRulesOutput

type ListRulesOutput struct {

	// A token that can be used to resume pagination from the end of the collection.
	NextToken *string

	// A list of rules
	Rules []types.ListRulesOutput

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRulesPaginator

type ListRulesPaginator struct {
	// contains filtered or unexported fields
}

ListRulesPaginator is a paginator for ListRules

func NewListRulesPaginator

func NewListRulesPaginator(client ListRulesAPIClient, params *ListRulesInput, optFns ...func(*ListRulesPaginatorOptions)) *ListRulesPaginator

NewListRulesPaginator returns a new ListRulesPaginator

func (*ListRulesPaginator) HasMorePages

func (p *ListRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRulesPaginator) NextPage

func (p *ListRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRulesOutput, error)

NextPage retrieves the next ListRules page.

type ListRulesPaginatorOptions

type ListRulesPaginatorOptions struct {
	// Upper bound on number of records to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRulesPaginatorOptions is the paginator options for ListRules

type ListTagsForResourcesInput

type ListTagsForResourcesInput struct {

	// The Amazon Resource Name (ARN) for the resource. You can get this from the
	// response to any request to the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourcesOutput

type ListTagsForResourcesOutput struct {

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) for the resource. You can get this from the
	// response to any request to the resource.
	//
	// This member is required.
	ResourceArn *string

	// A collection of tags associated with a resource
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) for the resource. You can get this from the
	// response to any request to the resource.
	//
	// This member is required.
	ResourceArn *string

	// A comma-separated list of the tag keys to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCellInput

type UpdateCellInput struct {

	// The Cell to update
	//
	// This member is required.
	CellName *string

	// A list of Cell arns, completely replaces previous list
	//
	// This member is required.
	Cells []string
	// contains filtered or unexported fields
}

Parameters to update for the Cell

type UpdateCellOutput

type UpdateCellOutput struct {

	// The arn for the Cell
	CellArn *string

	// The name of the Cell
	CellName *string

	// A list of Cell arns
	Cells []string

	// A list of Cell ARNs and/or RecoveryGroup ARNs
	ParentReadinessScopes []string

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateReadinessCheckInput

type UpdateReadinessCheckInput struct {

	// The ReadinessCheck to update
	//
	// This member is required.
	ReadinessCheckName *string

	// The name of the ResourceSet to check
	//
	// This member is required.
	ResourceSetName *string
	// contains filtered or unexported fields
}

The new Readiness Check values

type UpdateReadinessCheckOutput

type UpdateReadinessCheckOutput struct {

	// Arn associated with ReadinessCheck
	ReadinessCheckArn *string

	// Name for a ReadinessCheck
	ReadinessCheckName *string

	// Name of the ResourceSet to be checked
	ResourceSet *string

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRecoveryGroupInput

type UpdateRecoveryGroupInput struct {

	// A list of Cell arns, completely replaces previous list
	//
	// This member is required.
	Cells []string

	// The RecoveryGroup to update
	//
	// This member is required.
	RecoveryGroupName *string
	// contains filtered or unexported fields
}

Parameters to update for the RecoveryGroup

type UpdateRecoveryGroupOutput

type UpdateRecoveryGroupOutput struct {

	// A list of Cell arns
	Cells []string

	// The arn for the RecoveryGroup
	RecoveryGroupArn *string

	// The name of the RecoveryGroup
	RecoveryGroupName *string

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateResourceSetInput

type UpdateResourceSetInput struct {

	// The ResourceSet to update
	//
	// This member is required.
	ResourceSetName *string

	// AWS Resource Type of the resources in the ResourceSet
	//
	// This member is required.
	ResourceSetType *string

	// A list of Resource objects
	//
	// This member is required.
	Resources []types.Resource
	// contains filtered or unexported fields
}

configuration for the desired

type UpdateResourceSetOutput

type UpdateResourceSetOutput struct {

	// The arn for the ResourceSet
	ResourceSetArn *string

	// The name of the ResourceSet
	ResourceSetName *string

	// AWS Resource Type of the resources in the ResourceSet
	ResourceSetType *string

	// A list of Resource objects
	Resources []types.Resource

	// A collection of tags associated with a resource
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL