types

package
v1.2.6 Latest Latest
Warning

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

 Go to latest Published: Sep 10, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbbreviatedExecution 

type AbbreviatedExecution struct {

	// The plan execution action. Valid values are Activate , to activate an Amazon Web
	// Services Region, or Deactivate , to deactivate a Region.
	//
	// This member is required.
	ExecutionAction ExecutionAction

	// The execution identifier of a plan execution.
	//
	// This member is required.
	ExecutionId *string

	// The Amazon Web Services Region for a plan execution.
	//
	// This member is required.
	ExecutionRegion *string

	// The plan execution state. Provides the state of a plan execution, for example,
	// In Progress or Paused by Operator.
	//
	// This member is required.
	ExecutionState ExecutionState

	// The plan execution mode. Valid values are Practice , for testing without making
	// actual changes, or Recovery , for actual traffic shifting and application
	// recovery.
	//
	// This member is required.
	Mode ExecutionMode

	// The Amazon Resource Name (ARN) of the plan.
	//
	// This member is required.
	PlanArn *string

	// The timestamp when the plan execution was started.
	//
	// This member is required.
	StartTime *time.Time

	// The actual recovery time that Region switch calculates for a plan execution.
	// Actual recovery time includes the time for the plan to run added to the time
	// elapsed until the application health alarms that you've specified are healthy
	// again.
	ActualRecoveryTime *string

	// An optional comment about the plan execution.
	Comment *string

	// The timestamp when the plan execution was ended.
	EndTime *time.Time

	// The timestamp when the plan execution was last updated.
	UpdatedAt *time.Time

	// The version for the plan.
	Version *string
	// contains filtered or unexported fields
}

A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.

type AbbreviatedPlan 

type AbbreviatedPlan struct {

	// The Amazon Resource Name (ARN) of the Region switch plan.
	//
	// This member is required.
	Arn *string

	// The name of a Region switch plan.
	//
	// This member is required.
	Name *string

	// The owner of a Region switch plan.
	//
	// This member is required.
	Owner *string

	// The recovery approach for a Region switch plan, which can be active/active
	// (activeActive) or active/passive (activePassive).
	//
	// This member is required.
	RecoveryApproach RecoveryApproach

	// The Amazon Web Services Region specified for a Region switch plan.
	//
	// This member is required.
	Regions []string

	// Specifies if this is the active plan execution at this time.
	ActivePlanExecution *string

	// The description of a Region switch plan.
	Description *string

	// The execution role is a way to categorize a Region switch plan.
	ExecutionRole *string

	// The primary Region for a plan.
	PrimaryRegion *string

	// The recovery time objective that you've specified.
	RecoveryTimeObjectiveMinutes *int32

	// The timestamp when the plan execution was last updated.
	UpdatedAt *time.Time

	// The version for the plan.
	Version *string
	// contains filtered or unexported fields
}

A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

HTTP Status Code: 403

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AlarmCondition 

type AlarmCondition string
const (
	AlarmConditionRed   AlarmCondition = "red"
	AlarmConditionGreen AlarmCondition = "green"
)

Enum values for AlarmCondition

func (AlarmCondition) Values 

func (AlarmCondition) Values() []AlarmCondition

Values returns all known values for AlarmCondition. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AlarmType 

type AlarmType string
const (
	AlarmTypeApplicationHealth AlarmType = "applicationHealth"
	AlarmTypeTrigger           AlarmType = "trigger"
)

Enum values for AlarmType

func (AlarmType) Values 

func (AlarmType) Values() []AlarmType

Values returns all known values for AlarmType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Approval 

type Approval string
const (
	ApprovalApprove Approval = "approve"
	ApprovalDecline Approval = "decline"
)

Enum values for Approval

func (Approval) Values 

func (Approval) Values() []Approval

Values returns all known values for Approval. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ArcRoutingControlConfiguration 

type ArcRoutingControlConfiguration struct {

	// The Region and ARC routing controls for the configuration.
	//
	// This member is required.
	RegionAndRoutingControls map[string][]ArcRoutingControlState

	// The cross account role for the configuration.
	CrossAccountRole *string

	// The external ID (secret key) for the configuration.
	ExternalId *string

	// The timeout value specified for the configuration.
	TimeoutMinutes *int32
	// contains filtered or unexported fields
}

Configuration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.

type ArcRoutingControlState 

type ArcRoutingControlState struct {

	// The Amazon Resource Name (ARN) of a routing control.
	//
	// This member is required.
	RoutingControlArn *string

	// The state of an ARC routing control, On or Off.
	//
	// This member is required.
	State RoutingControlStateChange
	// contains filtered or unexported fields
}

Represents the state of an ARC routing control.

type Asg 

type Asg struct {

	// The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
	Arn *string

	// The cross account role for the configuration.
	CrossAccountRole *string

	// The external ID (secret key) for the configuration.
	ExternalId *string
	// contains filtered or unexported fields
}

Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.

type AssociatedAlarm 

type AssociatedAlarm struct {

	// The alarm type for an associated alarm. An associated CloudWatch alarm can be
	// an application health alarm or a trigger alarm.
	//
	// This member is required.
	AlarmType AlarmType

	// The resource identifier for alarms that you associate with a plan.
	//
	// This member is required.
	ResourceIdentifier *string

	// The cross account role for the configuration.
	CrossAccountRole *string

	// The external ID (secret key) for the configuration.
	ExternalId *string
	// contains filtered or unexported fields
}

An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.

type CustomActionLambdaConfiguration 

type CustomActionLambdaConfiguration struct {

	// The Amazon Web Services Lambda functions for the execution block.
	//
	// This member is required.
	Lambdas []Lambdas

	// The Amazon Web Services Region for the function to run in.
	//
	// This member is required.
	RegionToRun RegionToRunIn

	// The retry interval specified.
	//
	// This member is required.
	RetryIntervalMinutes *float32

	// The timeout value specified for the configuration.
	TimeoutMinutes *int32

	// The settings for ungraceful execution.
	Ungraceful *LambdaUngraceful
	// contains filtered or unexported fields
}

Configuration for Amazon Web Services Lambda functions that perform custom actions during a Region switch.

type Ec2AsgCapacityIncreaseConfiguration 

type Ec2AsgCapacityIncreaseConfiguration struct {

	// The EC2 Auto Scaling groups for the configuration.
	//
	// This member is required.
	Asgs []Asg

	// The monitoring approach that you specify EC2 Auto Scaling groups for the
	// configuration.
	CapacityMonitoringApproach Ec2AsgCapacityMonitoringApproach

	// The target percentage that you specify for EC2 Auto Scaling groups.
	TargetPercent *int32

	// The timeout value specified for the configuration.
	TimeoutMinutes *int32

	// The settings for ungraceful execution.
	Ungraceful *Ec2Ungraceful
	// contains filtered or unexported fields
}

Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.

type Ec2AsgCapacityMonitoringApproach 

type Ec2AsgCapacityMonitoringApproach string
const (
	Ec2AsgCapacityMonitoringApproachSampledMaxInLast24Hours     Ec2AsgCapacityMonitoringApproach = "sampledMaxInLast24Hours"
	Ec2AsgCapacityMonitoringApproachAutoscalingMaxInLast24Hours Ec2AsgCapacityMonitoringApproach = "autoscalingMaxInLast24Hours"
)

Enum values for Ec2AsgCapacityMonitoringApproach

func (Ec2AsgCapacityMonitoringApproach) Values 

func (Ec2AsgCapacityMonitoringApproach) Values() []Ec2AsgCapacityMonitoringApproach

Values returns all known values for Ec2AsgCapacityMonitoringApproach. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Ec2Ungraceful 

type Ec2Ungraceful struct {

	// The minimum success percentage that you specify for EC2 Auto Scaling groups.
	//
	// This member is required.
	MinimumSuccessPercentage *int32
	// contains filtered or unexported fields
}

Configuration for handling failures when performing operations on EC2 resources.

type EcsCapacityIncreaseConfiguration 

type EcsCapacityIncreaseConfiguration struct {

	// The services specified for the configuration.
	//
	// This member is required.
	Services []Service

	// The monitoring approach specified for the configuration, for example,
	// Most_Recent .
	CapacityMonitoringApproach EcsCapacityMonitoringApproach

	// The target percentage specified for the configuration.
	TargetPercent *int32

	// The timeout value specified for the configuration.
	TimeoutMinutes *int32

	// The settings for ungraceful execution.
	Ungraceful *EcsUngraceful
	// contains filtered or unexported fields
}

The configuration for an Amazon Web Services ECS capacity increase.

type EcsCapacityMonitoringApproach 

type EcsCapacityMonitoringApproach string
const (
	EcsCapacityMonitoringApproachSampledMaxInLast24Hours           EcsCapacityMonitoringApproach = "sampledMaxInLast24Hours"
	EcsCapacityMonitoringApproachContainerInsightsMaxInLast24Hours EcsCapacityMonitoringApproach = "containerInsightsMaxInLast24Hours"
)

Enum values for EcsCapacityMonitoringApproach

func (EcsCapacityMonitoringApproach) Values 

func (EcsCapacityMonitoringApproach) Values() []EcsCapacityMonitoringApproach

Values returns all known values for EcsCapacityMonitoringApproach. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EcsUngraceful 

type EcsUngraceful struct {

	// The minimum success percentage specified for the configuration.
	//
	// This member is required.
	MinimumSuccessPercentage *int32
	// contains filtered or unexported fields
}

The settings for ungraceful execution.

type EksCapacityMonitoringApproach 

type EksCapacityMonitoringApproach string
const (
	EksCapacityMonitoringApproachSampledMaxInLast24Hours EksCapacityMonitoringApproach = "sampledMaxInLast24Hours"
)

Enum values for EksCapacityMonitoringApproach

func (EksCapacityMonitoringApproach) Values 

func (EksCapacityMonitoringApproach) Values() []EksCapacityMonitoringApproach

Values returns all known values for EksCapacityMonitoringApproach. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EksCluster 

type EksCluster struct {

	// The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
	//
	// This member is required.
	ClusterArn *string

	// The cross account role for the configuration.
	CrossAccountRole *string

	// The external ID (secret key) for the configuration.
	ExternalId *string
	// contains filtered or unexported fields
}

The Amazon Web Services EKS cluster execution block configuration.

type EksResourceScalingConfiguration 

type EksResourceScalingConfiguration struct {

	// The Kubernetes resource type for the configuration.
	//
	// This member is required.
	KubernetesResourceType *KubernetesResourceType

	// The monitoring approach for the configuration, that is, whether it was sampled
	// in the last 24 hours or autoscaled in the last 24 hours.
	CapacityMonitoringApproach EksCapacityMonitoringApproach

	// The clusters for the configuration.
	EksClusters []EksCluster

	// The scaling resources for the configuration.
	ScalingResources []map[string]map[string]KubernetesScalingResource

	// The target percentage for the configuration.
	TargetPercent *int32

	// The timeout value specified for the configuration.
	TimeoutMinutes *int32

	// The settings for ungraceful execution.
	Ungraceful *EksResourceScalingUngraceful
	// contains filtered or unexported fields
}

The Amazon Web Services EKS resource scaling configuration.

type EksResourceScalingUngraceful 

type EksResourceScalingUngraceful struct {

	// The minimum success percentage for the configuration.
	//
	// This member is required.
	MinimumSuccessPercentage *int32
	// contains filtered or unexported fields
}

The ungraceful settings for Amazon Web Services EKS resource scaling.

type EvaluationStatus 

type EvaluationStatus string
const (
	EvaluationStatusPassed            EvaluationStatus = "passed"
	EvaluationStatusActionRequired    EvaluationStatus = "actionRequired"
	EvaluationStatusPendingEvaluation EvaluationStatus = "pendingEvaluation"
	EvaluationStatusUnknown           EvaluationStatus = "unknown"
)

Enum values for EvaluationStatus

func (EvaluationStatus) Values 

func (EvaluationStatus) Values() []EvaluationStatus

Values returns all known values for EvaluationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionAction 

type ExecutionAction string
const (
	ExecutionActionActivate   ExecutionAction = "activate"
	ExecutionActionDeactivate ExecutionAction = "deactivate"
)

Enum values for ExecutionAction

func (ExecutionAction) Values 

func (ExecutionAction) Values() []ExecutionAction

Values returns all known values for ExecutionAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionApprovalConfiguration 

type ExecutionApprovalConfiguration struct {

	// The IAM approval role for the configuration.
	//
	// This member is required.
	ApprovalRole *string

	// The timeout value specified for the configuration.
	TimeoutMinutes *int32
	// contains filtered or unexported fields
}

Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.

type ExecutionBlockConfiguration 

type ExecutionBlockConfiguration interface {
	// contains filtered or unexported methods
}

Execution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.

The following types satisfy this interface: 

ExecutionBlockConfigurationMemberArcRoutingControlConfig
ExecutionBlockConfigurationMemberCustomActionLambdaConfig
ExecutionBlockConfigurationMemberEc2AsgCapacityIncreaseConfig
ExecutionBlockConfigurationMemberEcsCapacityIncreaseConfig
ExecutionBlockConfigurationMemberEksResourceScalingConfig
ExecutionBlockConfigurationMemberExecutionApprovalConfig
ExecutionBlockConfigurationMemberGlobalAuroraConfig
ExecutionBlockConfigurationMemberParallelConfig
ExecutionBlockConfigurationMemberRegionSwitchPlanConfig
ExecutionBlockConfigurationMemberRoute53HealthCheckConfig
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/arcregionswitch/types"
)

func main() {
	var union types.ExecutionBlockConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ExecutionBlockConfigurationMemberArcRoutingControlConfig:
		_ = v.Value // Value is types.ArcRoutingControlConfiguration

	case *types.ExecutionBlockConfigurationMemberCustomActionLambdaConfig:
		_ = v.Value // Value is types.CustomActionLambdaConfiguration

	case *types.ExecutionBlockConfigurationMemberEc2AsgCapacityIncreaseConfig:
		_ = v.Value // Value is types.Ec2AsgCapacityIncreaseConfiguration

	case *types.ExecutionBlockConfigurationMemberEcsCapacityIncreaseConfig:
		_ = v.Value // Value is types.EcsCapacityIncreaseConfiguration

	case *types.ExecutionBlockConfigurationMemberEksResourceScalingConfig:
		_ = v.Value // Value is types.EksResourceScalingConfiguration

	case *types.ExecutionBlockConfigurationMemberExecutionApprovalConfig:
		_ = v.Value // Value is types.ExecutionApprovalConfiguration

	case *types.ExecutionBlockConfigurationMemberGlobalAuroraConfig:
		_ = v.Value // Value is types.GlobalAuroraConfiguration

	case *types.ExecutionBlockConfigurationMemberParallelConfig:
		_ = v.Value // Value is types.ParallelExecutionBlockConfiguration

	case *types.ExecutionBlockConfigurationMemberRegionSwitchPlanConfig:
		_ = v.Value // Value is types.RegionSwitchPlanConfiguration

	case *types.ExecutionBlockConfigurationMemberRoute53HealthCheckConfig:
		_ = v.Value // Value is types.Route53HealthCheckConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *types.GlobalAuroraConfiguration
var _ *types.EcsCapacityIncreaseConfiguration
var _ *types.ParallelExecutionBlockConfiguration
var _ *types.Route53HealthCheckConfiguration
var _ *types.ExecutionApprovalConfiguration
var _ *types.ArcRoutingControlConfiguration
var _ *types.Ec2AsgCapacityIncreaseConfiguration
var _ *types.EksResourceScalingConfiguration
var _ *types.RegionSwitchPlanConfiguration
var _ *types.CustomActionLambdaConfiguration

type ExecutionBlockConfigurationMemberArcRoutingControlConfig 

type ExecutionBlockConfigurationMemberArcRoutingControlConfig struct {
	Value ArcRoutingControlConfiguration
	// contains filtered or unexported fields
}

An ARC routing control execution block.

type ExecutionBlockConfigurationMemberCustomActionLambdaConfig 

type ExecutionBlockConfigurationMemberCustomActionLambdaConfig struct {
	Value CustomActionLambdaConfiguration
	// contains filtered or unexported fields
}

An Amazon Web Services Lambda execution block.

type ExecutionBlockConfigurationMemberEc2AsgCapacityIncreaseConfig 

type ExecutionBlockConfigurationMemberEc2AsgCapacityIncreaseConfig struct {
	Value Ec2AsgCapacityIncreaseConfiguration
	// contains filtered or unexported fields
}

An EC2 Auto Scaling group execution block.

type ExecutionBlockConfigurationMemberEcsCapacityIncreaseConfig 

type ExecutionBlockConfigurationMemberEcsCapacityIncreaseConfig struct {
	Value EcsCapacityIncreaseConfiguration
	// contains filtered or unexported fields
}

The capacity increase specified for the configuration.

type ExecutionBlockConfigurationMemberEksResourceScalingConfig 

type ExecutionBlockConfigurationMemberEksResourceScalingConfig struct {
	Value EksResourceScalingConfiguration
	// contains filtered or unexported fields
}

An Amazon Web Services EKS resource scaling execution block.

type ExecutionBlockConfigurationMemberExecutionApprovalConfig 

type ExecutionBlockConfigurationMemberExecutionApprovalConfig struct {
	Value ExecutionApprovalConfiguration
	// contains filtered or unexported fields
}

A manual approval execution block.

type ExecutionBlockConfigurationMemberGlobalAuroraConfig 

type ExecutionBlockConfigurationMemberGlobalAuroraConfig struct {
	Value GlobalAuroraConfiguration
	// contains filtered or unexported fields
}

An Aurora Global Database execution block.

type ExecutionBlockConfigurationMemberParallelConfig 

type ExecutionBlockConfigurationMemberParallelConfig struct {
	Value ParallelExecutionBlockConfiguration
	// contains filtered or unexported fields
}

A parallel configuration execution block.

type ExecutionBlockConfigurationMemberRegionSwitchPlanConfig 

type ExecutionBlockConfigurationMemberRegionSwitchPlanConfig struct {
	Value RegionSwitchPlanConfiguration
	// contains filtered or unexported fields
}

A Region switch plan execution block.

type ExecutionBlockConfigurationMemberRoute53HealthCheckConfig 

type ExecutionBlockConfigurationMemberRoute53HealthCheckConfig struct {
	Value Route53HealthCheckConfiguration
	// contains filtered or unexported fields
}

The Amazon Route 53 health check configuration.

type ExecutionBlockType 

type ExecutionBlockType string
const (
	ExecutionBlockTypeCustomActionLambda ExecutionBlockType = "CustomActionLambda"
	ExecutionBlockTypeExecutionApproval  ExecutionBlockType = "ManualApproval"
	ExecutionBlockTypeAurora             ExecutionBlockType = "AuroraGlobalDatabase"
	ExecutionBlockTypeEc2Asg             ExecutionBlockType = "EC2AutoScaling"
	ExecutionBlockTypeRoutingControl     ExecutionBlockType = "ARCRoutingControl"
	ExecutionBlockTypeRegionSwitch       ExecutionBlockType = "ARCRegionSwitchPlan"
	ExecutionBlockTypeParallel           ExecutionBlockType = "Parallel"
	ExecutionBlockTypeEcs                ExecutionBlockType = "ECSServiceScaling"
	ExecutionBlockTypeEksResourceScaling ExecutionBlockType = "EKSResourceScaling"
	ExecutionBlockTypeRoute53HealthCheck ExecutionBlockType = "Route53HealthCheck"
)

Enum values for ExecutionBlockType

func (ExecutionBlockType) Values 

func (ExecutionBlockType) Values() []ExecutionBlockType

Values returns all known values for ExecutionBlockType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionEvent 

type ExecutionEvent struct {

	// The event ID for an execution event.
	//
	// This member is required.
	EventId *string

	// The description for an execution event.
	Description *string

	// Errors for an execution event.
	Error *string

	// The execution block type for an execution event.
	ExecutionBlockType ExecutionBlockType

	// The event ID of the previous execution event.
	PreviousEventId *string

	// The resources for an execution event.
	Resources []string

	// The step name for an execution event.
	StepName *string

	// The timestamp for an execution event.
	Timestamp *time.Time

	// The type of an execution event.
	Type ExecutionEventType
	// contains filtered or unexported fields
}

Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.

type ExecutionEventType 

type ExecutionEventType string
const (
	ExecutionEventTypeUnknown                                     ExecutionEventType = "unknown"
	ExecutionEventTypeExecutionPending                            ExecutionEventType = "executionPending"
	ExecutionEventTypeExecutionStarted                            ExecutionEventType = "executionStarted"
	ExecutionEventTypeExecutionSucceeded                          ExecutionEventType = "executionSucceeded"
	ExecutionEventTypeExecutionFailed                             ExecutionEventType = "executionFailed"
	ExecutionEventTypeExecutionPausing                            ExecutionEventType = "executionPausing"
	ExecutionEventTypeExecutionPaused                             ExecutionEventType = "executionPaused"
	ExecutionEventTypeExecutionCanceling                          ExecutionEventType = "executionCanceling"
	ExecutionEventTypeExecutionCanceled                           ExecutionEventType = "executionCanceled"
	ExecutionEventTypeExecutionPendingApproval                    ExecutionEventType = "executionPendingApproval"
	ExecutionEventTypeExecutionBehaviorChangedToUngraceful        ExecutionEventType = "executionBehaviorChangedToUngraceful"
	ExecutionEventTypeExecutionBehaviorChangedToGraceful          ExecutionEventType = "executionBehaviorChangedToGraceful"
	ExecutionEventTypeExecutionPendingChildPlanManualApproval     ExecutionEventType = "executionPendingChildPlanManualApproval"
	ExecutionEventTypeExecutionSuccessMonitoringApplicationHealth ExecutionEventType = "executionSuccessMonitoringApplicationHealth"
	ExecutionEventTypeStepStarted                                 ExecutionEventType = "stepStarted"
	ExecutionEventTypeStepUpdate                                  ExecutionEventType = "stepUpdate"
	ExecutionEventTypeStepSucceeded                               ExecutionEventType = "stepSucceeded"
	ExecutionEventTypeStepFailed                                  ExecutionEventType = "stepFailed"
	ExecutionEventTypeStepSkipped                                 ExecutionEventType = "stepSkipped"
	ExecutionEventTypeStepPausedByError                           ExecutionEventType = "stepPausedByError"
	ExecutionEventTypeStepPausedByOperator                        ExecutionEventType = "stepPausedByOperator"
	ExecutionEventTypeStepCanceled                                ExecutionEventType = "stepCanceled"
	ExecutionEventTypeStepPendingApproval                         ExecutionEventType = "stepPendingApproval"
	ExecutionEventTypeStepExecutionBehaviorChangedToUngraceful    ExecutionEventType = "stepExecutionBehaviorChangedToUngraceful"
	ExecutionEventTypeStepPendingApplicationHealthMonitor         ExecutionEventType = "stepPendingApplicationHealthMonitor"
)

Enum values for ExecutionEventType

func (ExecutionEventType) Values 

func (ExecutionEventType) Values() []ExecutionEventType

Values returns all known values for ExecutionEventType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionMode 

type ExecutionMode string
const (
	ExecutionModeGraceful   ExecutionMode = "graceful"
	ExecutionModeUngraceful ExecutionMode = "ungraceful"
)

Enum values for ExecutionMode

func (ExecutionMode) Values 

func (ExecutionMode) Values() []ExecutionMode

Values returns all known values for ExecutionMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionState 

type ExecutionState string
const (
	ExecutionStateInProgress                           ExecutionState = "inProgress"
	ExecutionStatePausedByFailedStep                   ExecutionState = "pausedByFailedStep"
	ExecutionStatePausedByOperator                     ExecutionState = "pausedByOperator"
	ExecutionStateCompleted                            ExecutionState = "completed"
	ExecutionStateCompletedWithExceptions              ExecutionState = "completedWithExceptions"
	ExecutionStateCancelled                            ExecutionState = "canceled"
	ExecutionStatePlanExecutionTimedOut                ExecutionState = "planExecutionTimedOut"
	ExecutionStatePendingManualApproval                ExecutionState = "pendingManualApproval"
	ExecutionStateFailed                               ExecutionState = "failed"
	ExecutionStatePending                              ExecutionState = "pending"
	ExecutionStateCompletedMonitoringApplicationHealth ExecutionState = "completedMonitoringApplicationHealth"
)

Enum values for ExecutionState

func (ExecutionState) Values 

func (ExecutionState) Values() []ExecutionState

Values returns all known values for ExecutionState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GlobalAuroraConfiguration 

type GlobalAuroraConfiguration struct {

	// The behavior for a global database, that is, only allow switchover or also
	// allow failover.
	//
	// This member is required.
	Behavior GlobalAuroraDefaultBehavior

	// The database cluster Amazon Resource Names (ARNs) for a global database.
	//
	// This member is required.
	DatabaseClusterArns []string

	// The global cluster identifier for a global database.
	//
	// This member is required.
	GlobalClusterIdentifier *string

	// The cross account role for the configuration.
	CrossAccountRole *string

	// The external ID (secret key) for the configuration.
	ExternalId *string

	// The timeout value specified for the configuration.
	TimeoutMinutes *int32

	// The settings for ungraceful execution.
	Ungraceful *GlobalAuroraUngraceful
	// contains filtered or unexported fields
}

Configuration for Amazon Aurora global databases used in a Region switch plan.

type GlobalAuroraDefaultBehavior 

type GlobalAuroraDefaultBehavior string
const (
	GlobalAuroraDefaultBehaviorSwitchoverOnly GlobalAuroraDefaultBehavior = "switchoverOnly"
	GlobalAuroraDefaultBehaviorFailover       GlobalAuroraDefaultBehavior = "failover"
)

Enum values for GlobalAuroraDefaultBehavior

func (GlobalAuroraDefaultBehavior) Values 

func (GlobalAuroraDefaultBehavior) Values() []GlobalAuroraDefaultBehavior

Values returns all known values for GlobalAuroraDefaultBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GlobalAuroraUngraceful 

type GlobalAuroraUngraceful struct {

	// The settings for ungraceful execution.
	Ungraceful GlobalAuroraUngracefulBehavior
	// contains filtered or unexported fields
}

Configuration for handling failures when performing operations on Aurora global databases.

type GlobalAuroraUngracefulBehavior 

type GlobalAuroraUngracefulBehavior string
const (
	GlobalAuroraUngracefulBehaviorFailover GlobalAuroraUngracefulBehavior = "failover"
)

Enum values for GlobalAuroraUngracefulBehavior

func (GlobalAuroraUngracefulBehavior) Values 

func (GlobalAuroraUngracefulBehavior) Values() []GlobalAuroraUngracefulBehavior

Values returns all known values for GlobalAuroraUngracefulBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IllegalArgumentException 

type IllegalArgumentException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request processing has an invalid argument.

func (*IllegalArgumentException) Error 

func (e *IllegalArgumentException) Error() string

func (*IllegalArgumentException) ErrorCode 

func (e *IllegalArgumentException) ErrorCode() string

func (*IllegalArgumentException) ErrorFault 

func (e *IllegalArgumentException) ErrorFault() smithy.ErrorFault

func (*IllegalArgumentException) ErrorMessage 

func (e *IllegalArgumentException) ErrorMessage() string

type IllegalStateException 

type IllegalStateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because the current state of the resource doesn't allow the operation to proceed.

HTTP Status Code: 400

func (*IllegalStateException) Error 

func (e *IllegalStateException) Error() string

func (*IllegalStateException) ErrorCode 

func (e *IllegalStateException) ErrorCode() string

func (*IllegalStateException) ErrorFault 

func (e *IllegalStateException) ErrorFault() smithy.ErrorFault

func (*IllegalStateException) ErrorMessage 

func (e *IllegalStateException) ErrorMessage() string

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type KubernetesResourceType 

type KubernetesResourceType struct {

	// The API version type for the Kubernetes resource.
	//
	// This member is required.
	ApiVersion *string

	// The kind for the Kubernetes resource.
	//
	// This member is required.
	Kind *string
	// contains filtered or unexported fields
}

Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.

type KubernetesScalingResource 

type KubernetesScalingResource struct {

	// The name for the Kubernetes resource.
	//
	// This member is required.
	Name *string

	// The namespace for the Kubernetes resource.
	//
	// This member is required.
	Namespace *string

	// The hpaname for the Kubernetes resource.
	HpaName *string
	// contains filtered or unexported fields
}

Defines a Kubernetes resource to scale in an Amazon EKS cluster.

type LambdaUngraceful 

type LambdaUngraceful struct {

	// The ungraceful behavior for a Lambda function, which must be set to skip .
	Behavior LambdaUngracefulBehavior
	// contains filtered or unexported fields
}

Configuration for handling failures when invoking Lambda functions.

type LambdaUngracefulBehavior 

type LambdaUngracefulBehavior string
const (
	LambdaUngracefulBehaviorSkip LambdaUngracefulBehavior = "skip"
)

Enum values for LambdaUngracefulBehavior

func (LambdaUngracefulBehavior) Values 

func (LambdaUngracefulBehavior) Values() []LambdaUngracefulBehavior

Values returns all known values for LambdaUngracefulBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Lambdas 

type Lambdas struct {

	// The Amazon Resource Name (ARN) of the Lambda function.
	Arn *string

	// The cross account role for the configuration.
	CrossAccountRole *string

	// The external ID (secret key) for the configuration.
	ExternalId *string
	// contains filtered or unexported fields
}

Configuration for Amazon Web Services Lambda functions used in a Region switch plan.

type MinimalWorkflow 

type MinimalWorkflow struct {

	// The action for a minimal workflow, which can be Activate or Deactivate.
	Action ExecutionAction

	// The name for a minimal workflow
	Name *string
	// contains filtered or unexported fields
}

A simplified representation of a workflow in a Region switch plan.

type ParallelExecutionBlockConfiguration 

type ParallelExecutionBlockConfiguration struct {

	// The steps for a parallel execution block.
	//
	// This member is required.
	Steps []Step
	// contains filtered or unexported fields
}

Configuration for steps that should be executed in parallel during a Region switch.

type Plan 

type Plan struct {

	// The Amazon Resource Name (ARN) of the plan.
	//
	// This member is required.
	Arn *string

	// The execution role for a plan.
	//
	// This member is required.
	ExecutionRole *string

	// The name for a plan.
	//
	// This member is required.
	Name *string

	// The owner of a plan.
	//
	// This member is required.
	Owner *string

	// The recovery approach for a Region switch plan, which can be active/active
	// (activeActive) or active/passive (activePassive).
	//
	// This member is required.
	RecoveryApproach RecoveryApproach

	// The Amazon Web Services Regions for a plan.
	//
	// This member is required.
	Regions []string

	// The workflows for a plan.
	//
	// This member is required.
	Workflows []Workflow

	// The associated application health alarms for a plan.
	AssociatedAlarms map[string]AssociatedAlarm

	// The description for a plan.
	Description *string

	// The primary Region for a plan.
	PrimaryRegion *string

	// The recovery time objective for a plan.
	RecoveryTimeObjectiveMinutes *int32

	// The triggers for a plan.
	Triggers []Trigger

	// The timestamp when the plan was last updated.
	UpdatedAt *time.Time

	// The version for the plan.
	Version *string
	// contains filtered or unexported fields
}

Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.

type RecoveryApproach 

type RecoveryApproach string
const (
	RecoveryApproachActiveActive  RecoveryApproach = "activeActive"
	RecoveryApproachActivePassive RecoveryApproach = "activePassive"
)

Enum values for RecoveryApproach

func (RecoveryApproach) Values 

func (RecoveryApproach) Values() []RecoveryApproach

Values returns all known values for RecoveryApproach. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RegionSwitchPlanConfiguration 

type RegionSwitchPlanConfiguration struct {

	// The Amazon Resource Name (ARN) of the plan configuration.
	//
	// This member is required.
	Arn *string

	// The cross account role for the configuration.
	CrossAccountRole *string

	// The external ID (secret key) for the configuration.
	ExternalId *string
	// contains filtered or unexported fields
}

Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.

type RegionToRunIn 

type RegionToRunIn string
const (
	RegionToRunInActivatingRegion   RegionToRunIn = "activatingRegion"
	RegionToRunInDeactivatingRegion RegionToRunIn = "deactivatingRegion"
)

Enum values for RegionToRunIn

func (RegionToRunIn) Values 

func (RegionToRunIn) Values() []RegionToRunIn

Values returns all known values for RegionToRunIn. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified resource was not found.

HTTP Status Code: 404

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceWarning 

type ResourceWarning struct {

	// The version for the resource warning.
	//
	// This member is required.
	Version *string

	// The warning message about what needs to be corrected.
	//
	// This member is required.
	WarningMessage *string

	// The status of the resource warning.
	//
	// This member is required.
	WarningStatus ResourceWarningStatus

	// The timestamp when the warning was last updated.
	//
	// This member is required.
	WarningUpdatedTime *time.Time

	// The Amazon Resource Name (ARN) of the resource.
	ResourceArn *string

	// The name of the step for the resource warning.
	StepName *string

	// The workflow for the resource warning.
	Workflow *MinimalWorkflow
	// contains filtered or unexported fields
}

Represents a warning about a resource in a Region switch plan.

type ResourceWarningStatus 

type ResourceWarningStatus string
const (
	ResourceWarningStatusActive   ResourceWarningStatus = "active"
	ResourceWarningStatusResolved ResourceWarningStatus = "resolved"
)

Enum values for ResourceWarningStatus

func (ResourceWarningStatus) Values 

func (ResourceWarningStatus) Values() []ResourceWarningStatus

Values returns all known values for ResourceWarningStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Route53HealthCheck 

type Route53HealthCheck struct {

	// The Amazon Route 53 health check hosted zone ID.
	//
	// This member is required.
	HostedZoneId *string

	// The Amazon Route 53 record name.
	//
	// This member is required.
	RecordName *string

	// The Amazon Route 53 Region.
	//
	// This member is required.
	Region *string

	// The Amazon Route 53 health check ID.
	HealthCheckId *string
	// contains filtered or unexported fields
}

The Amazon Route 53 health check.

type Route53HealthCheckConfiguration 

type Route53HealthCheckConfiguration struct {

	// The Amazon Route 53 health check configuration hosted zone ID.
	//
	// This member is required.
	HostedZoneId *string

	// The Amazon Route 53 health check configuration record name.
	//
	// This member is required.
	RecordName *string

	// The cross account role for the configuration.
	CrossAccountRole *string

	// The external ID (secret key) for the configuration.
	ExternalId *string

	// The Amazon Route 53 health check configuration record sets.
	RecordSets []Route53ResourceRecordSet

	// The Amazon Route 53 health check configuration time out (in minutes).
	TimeoutMinutes *int32
	// contains filtered or unexported fields
}

The Amazon Route 53 health check configuration.

type Route53ResourceRecordSet 

type Route53ResourceRecordSet struct {

	// The Amazon Route 53 record set identifier.
	RecordSetIdentifier *string

	// The Amazon Route 53 record set Region.
	Region *string
	// contains filtered or unexported fields
}

The Amazon Route 53 record set.

type RoutingControlStateChange 

type RoutingControlStateChange string
const (
	RoutingControlStateChangeOn  RoutingControlStateChange = "On"
	RoutingControlStateChangeOff RoutingControlStateChange = "Off"
)

Enum values for RoutingControlStateChange

func (RoutingControlStateChange) Values 

func (RoutingControlStateChange) Values() []RoutingControlStateChange

Values returns all known values for RoutingControlStateChange. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Service 

type Service struct {

	// The cluster Amazon Resource Name (ARN) for a service.
	ClusterArn *string

	// The cross account role for a service.
	CrossAccountRole *string

	// The external ID (secret key) for the service.
	ExternalId *string

	// The Amazon Resource Name (ARN) for a service.
	ServiceArn *string
	// contains filtered or unexported fields
}

The service for a cross account role.

type Step 

type Step struct {

	// The configuration for an execution block in a workflow.
	//
	// This member is required.
	ExecutionBlockConfiguration ExecutionBlockConfiguration

	// The type of an execution block in a workflow.
	//
	// This member is required.
	ExecutionBlockType ExecutionBlockType

	// The name of a step in a workflow.
	//
	// This member is required.
	Name *string

	// The description of a step in a workflow.
	Description *string
	// contains filtered or unexported fields
}

Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.

type StepState 

type StepState struct {

	// The timestamp when a step endeded execution.
	EndTime *time.Time

	// The name of a step in a workflow.
	Name *string

	// The timestamp when a step started execution.
	StartTime *time.Time

	// The status of a step in a workflow. For example, a status might be Completed or
	// Pending Approval.
	Status StepStatus

	// The mode for a step execution. The mode can be Graceful or Ungraceful.
	StepMode ExecutionMode
	// contains filtered or unexported fields
}

Represents the state of a step in a plan execution.

type StepStatus 

type StepStatus string
const (
	StepStatusNotStarted      StepStatus = "notStarted"
	StepStatusRunning         StepStatus = "running"
	StepStatusFailed          StepStatus = "failed"
	StepStatusCompleted       StepStatus = "completed"
	StepStatusCancelled       StepStatus = "canceled"
	StepStatusSkipped         StepStatus = "skipped"
	StepStatusPendingApproval StepStatus = "pendingApproval"
)

Enum values for StepStatus

func (StepStatus) Values 

func (StepStatus) Values() []StepStatus

Values returns all known values for StepStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Trigger 

type Trigger struct {

	// The action to perform when the trigger fires. Valid values include ACTIVATE and
	// DEACTIVATE.
	//
	// This member is required.
	Action WorkflowTargetAction

	// The conditions that must be met for the trigger to fire.
	//
	// This member is required.
	Conditions []TriggerCondition

	// The minimum time, in minutes, that must elapse between automatic executions of
	// the plan.
	//
	// This member is required.
	MinDelayMinutesBetweenExecutions *int32

	// The Amazon Web Services Region for a trigger.
	//
	// This member is required.
	TargetRegion *string

	// The description for a trigger.
	Description *string
	// contains filtered or unexported fields
}

Defines a condition that can automatically trigger the execution of a Region switch plan.

type TriggerCondition 

type TriggerCondition struct {

	// The name of the CloudWatch alarm associated with the condition.
	//
	// This member is required.
	AssociatedAlarmName *string

	// The condition that must be met. Valid values include ALARM and OK.
	//
	// This member is required.
	Condition AlarmCondition
	// contains filtered or unexported fields
}

Defines a condition that must be met for a trigger to fire.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UpdatePlanExecutionAction 

type UpdatePlanExecutionAction string
const (
	UpdatePlanExecutionActionSwitchToGraceful   UpdatePlanExecutionAction = "switchToGraceful"
	UpdatePlanExecutionActionSwitchToUngraceful UpdatePlanExecutionAction = "switchToUngraceful"
	UpdatePlanExecutionActionPause              UpdatePlanExecutionAction = "pause"
	UpdatePlanExecutionActionResume             UpdatePlanExecutionAction = "resume"
)

Enum values for UpdatePlanExecutionAction

func (UpdatePlanExecutionAction) Values 

func (UpdatePlanExecutionAction) Values() []UpdatePlanExecutionAction

Values returns all known values for UpdatePlanExecutionAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UpdatePlanExecutionStepAction 

type UpdatePlanExecutionStepAction string
const (
	UpdatePlanExecutionStepActionSwitchToUngraceful UpdatePlanExecutionStepAction = "switchToUngraceful"
	UpdatePlanExecutionStepActionSkip               UpdatePlanExecutionStepAction = "skip"
)

Enum values for UpdatePlanExecutionStepAction

func (UpdatePlanExecutionStepAction) Values 

func (UpdatePlanExecutionStepAction) Values() []UpdatePlanExecutionStepAction

Values returns all known values for UpdatePlanExecutionStepAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Workflow 

type Workflow struct {

	// The action that the workflow performs. Valid values include ACTIVATE and
	// DEACTIVATE.
	//
	// This member is required.
	WorkflowTargetAction WorkflowTargetAction

	// The steps that make up the workflow.
	Steps []Step

	// The description of the workflow.
	WorkflowDescription *string

	// The Amazon Web Services Region that the workflow targets.
	WorkflowTargetRegion *string
	// contains filtered or unexported fields
}

Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.

type WorkflowTargetAction 

type WorkflowTargetAction string
const (
	WorkflowTargetActionActivate   WorkflowTargetAction = "activate"
	WorkflowTargetActionDeactivate WorkflowTargetAction = "deactivate"
)

Enum values for WorkflowTargetAction

func (WorkflowTargetAction) Values 

func (WorkflowTargetAction) Values() []WorkflowTargetAction

Values returns all known values for WorkflowTargetAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

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.