cloudformation

Documentation

Index

• func DeleteResource(ctx context.Context, conn *cloudcontrol.Client, roleARN, typeName, id string, ...) error
• func FindResourceByTypeNameAndID(ctx context.Context, conn *cloudcontrol.Client, roleARN, typeName, id string) (*types.ResourceDescription, error)
• func ListResourcesByTypeName(ctx context.Context, conn *cloudcontrol.Client, roleARN, typeName string) ([]types.ResourceDescription, error)
• func WaitForResourceRequestSuccess(ctx context.Context, client *cloudcontrol.Client, requestToken string, ...) (string, error)
• type GetResourceRequestStatusAPIClient
• type Provider
• type ResourceRequestStatusSuccessWaiter
  • func NewResourceRequestStatusSuccessWaiter(client GetResourceRequestStatusAPIClient, ...) *ResourceRequestStatusSuccessWaiter
  • func (w *ResourceRequestStatusSuccessWaiter) Wait(ctx context.Context, params *cloudcontrol.GetResourceRequestStatusInput, ...) error
• type ResourceRequestStatusSuccessWaiterOptions

Functions

func DeleteResource

func DeleteResource(ctx context.Context, conn *cloudcontrol.Client, roleARN, typeName, id string, maxWaitTime time.Duration) error

func FindResourceByTypeNameAndID

func FindResourceByTypeNameAndID(ctx context.Context, conn *cloudcontrol.Client, roleARN, typeName, id string) (*types.ResourceDescription, error)

func ListResourcesByTypeName

func ListResourcesByTypeName(ctx context.Context, conn *cloudcontrol.Client, roleARN, typeName string) ([]types.ResourceDescription, error)

func WaitForResourceRequestSuccess

func WaitForResourceRequestSuccess(ctx context.Context, client *cloudcontrol.Client, requestToken string, maxWaitTime time.Duration) (string, error)

WaitForResourceRequestSuccess waits up to maxWaitTime for the specified reource request to succeed.

Types

type GetResourceRequestStatusAPIClient

type GetResourceRequestStatusAPIClient interface {
	GetResourceRequestStatus(context.Context, *cloudcontrol.GetResourceRequestStatusInput, ...func(*cloudcontrol.Options)) (*cloudcontrol.GetResourceRequestStatusOutput, error)
}

GetResourceRequestStatusAPIClient is a client that implements the GetResourceRequestStatus operation.

type Provider

type Provider interface {
	// CloudControlApiClient returns an AWS Cloud Control API client.
	CloudControlApiClient(context.Context) *cloudcontrol.Client

	// Region returns and AWS Cloud Control API client's region
	Region(ctx context.Context) string

	// RoleARN returns an AWS Cloud Control API service role ARN.
	RoleARN(context.Context) string
}

Provider is the interface implemented by AWS Cloud Control API client providers.

type ResourceRequestStatusSuccessWaiter

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

ResourceRequestStatusSuccessWaiter defines the waiters for ResourceRequestStatusSuccess

func NewResourceRequestStatusSuccessWaiter

func NewResourceRequestStatusSuccessWaiter(client GetResourceRequestStatusAPIClient, optFns ...func(*ResourceRequestStatusSuccessWaiterOptions)) *ResourceRequestStatusSuccessWaiter

NewResourceRequestStatusSuccessWaiter constructs a ResourceRequestStatusSuccessWaiter.

func (*ResourceRequestStatusSuccessWaiter) Wait

func (w *ResourceRequestStatusSuccessWaiter) Wait(ctx context.Context, params *cloudcontrol.GetResourceRequestStatusInput, maxWaitDur time.Duration, optFns ...func(*ResourceRequestStatusSuccessWaiterOptions)) error

Wait calls the waiter function for ResourceRequestStatusSuccess waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ResourceRequestStatusSuccessWaiterOptions

type ResourceRequestStatusSuccessWaiterOptions 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

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ResourceRequestStatusSuccessWaiter will use default minimum delay of 30 seconds.
	// Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or set
	// to zero, ResourceRequestStatusSuccessWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *cloudcontrol.GetResourceRequestStatusInput, *cloudcontrol.GetResourceRequestStatusOutput, error) (bool, error)
}

ResourceRequestStatusSuccessWaiterOptions are waiter options for ResourceRequestStatusSuccessWaiter