cloudformation

Documentation

Overview

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Package cloudformation provides functionality to deploy oam-ecs resources with AWS CloudFormation.

Package cloudformation provides functionality to deploy oam-ecs resources with AWS CloudFormation.

Package deploy holds the structures to deploy infrastructure resources.

Package cloudformation provides functionality to deploy oam-ecs resources with AWS CloudFormation.

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Index

• type CloudFormation
  • func New(sess *session.Session) CloudFormation
  • func (cf CloudFormation) DeleteComponent(component *types.ComponentInput) (*types.Component, error)
  • func (cf CloudFormation) DeleteEnvironment(env *types.EnvironmentInput) (*types.Environment, error)
  • func (cf CloudFormation) DeployComponent(component *types.ComponentInput) (*types.Component, error)
  • func (cf CloudFormation) DeployEnvironment(env *types.EnvironmentInput) (*types.Environment, error)
  • func (cf CloudFormation) DescribeComponent(component *types.ComponentInput) (*types.Component, error)
  • func (cf CloudFormation) DescribeEnvironment(env *types.EnvironmentInput) (*types.Environment, error)
  • func (cf CloudFormation) DryRunComponent(component *types.ComponentInput) (string, error)
  • func (cf CloudFormation) DryRunEnvironment(env *types.EnvironmentInput) (string, error)
• type ErrNotExecutableChangeSet
  • func (err *ErrNotExecutableChangeSet) Error() string
• type ErrStackAlreadyExists
  • func (err *ErrStackAlreadyExists) Error() string
  • func (err *ErrStackAlreadyExists) Unwrap() error
• type ErrStackNotFound
  • func (err *ErrStackNotFound) Error() string
• type ErrStackSetOutOfDate
  • func (err *ErrStackSetOutOfDate) Error() string
  • func (err *ErrStackSetOutOfDate) Is(target error) bool
• type ErrStackUpdateInProgress
  • func (err *ErrStackUpdateInProgress) Error() string
• type ErrTemplateNotFound
  • func (err *ErrTemplateNotFound) Error() string
  • func (err *ErrTemplateNotFound) Is(target error) bool
  • func (err *ErrTemplateNotFound) Unwrap() error
• type Resource
• type ResourceEvent
• type StackStatus
  • func (s StackStatus) InProgress() bool
  • func (s StackStatus) RequiresCleanup() bool

Types

type CloudFormation

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

CloudFormation wraps the CloudFormationAPI interface

func New

func New(sess *session.Session) CloudFormation

New returns a configured CloudFormation client.

func (CloudFormation) DeleteComponent

func (cf CloudFormation) DeleteComponent(component *types.ComponentInput) (*types.Component, error)

DeleteComponent deletes the CloudFormation stack for a component instance

func (CloudFormation) DeleteEnvironment

func (cf CloudFormation) DeleteEnvironment(env *types.EnvironmentInput) (*types.Environment, error)

DeleteEnvironment deletes the CloudFormation stack for an environment

func (CloudFormation) DeployComponent

func (cf CloudFormation) DeployComponent(component *types.ComponentInput) (*types.Component, error)

DeployComponent creates the CloudFormation stack for a component instance by creating and executing a change set.

If the deployment succeeds, returns nil. If the stack already exists, update the stack. If the change set to create/update the stack cannot be executed, returns a ErrNotExecutableChangeSet. Otherwise, returns a wrapped error.

func (CloudFormation) DeployEnvironment

func (cf CloudFormation) DeployEnvironment(env *types.EnvironmentInput) (*types.Environment, error)

DeployEnvironment creates the CloudFormation stack for an environment by creating and executing a change set.

If the deployment succeeds, returns nil. If the stack already exists, update the stack. If the change set to create/update the stack cannot be executed, returns a ErrNotExecutableChangeSet. Otherwise, returns a wrapped error.

func (CloudFormation) DescribeComponent

func (cf CloudFormation) DescribeComponent(component *types.ComponentInput) (*types.Component, error)

DescribeComponent describes the existing CloudFormation stack for a component instance

func (CloudFormation) DescribeEnvironment

func (cf CloudFormation) DescribeEnvironment(env *types.EnvironmentInput) (*types.Environment, error)

DescribeEnvironment describes the existing CloudFormation stack for an environment

func (CloudFormation) DryRunComponent

func (cf CloudFormation) DryRunComponent(component *types.ComponentInput) (string, error)

func (CloudFormation) DryRunEnvironment

func (cf CloudFormation) DryRunEnvironment(env *types.EnvironmentInput) (string, error)

type ErrNotExecutableChangeSet

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

ErrNotExecutableChangeSet occurs when the change set cannot be executed.

func (*ErrNotExecutableChangeSet) Error

func (err *ErrNotExecutableChangeSet) Error() string

type ErrStackAlreadyExists

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

ErrStackAlreadyExists occurs when a CloudFormation stack already exists with a given name.

func (*ErrStackAlreadyExists) Error

func (err *ErrStackAlreadyExists) Error() string

func (*ErrStackAlreadyExists) Unwrap

func (err *ErrStackAlreadyExists) Unwrap() error

Unwrap returns the original CloudFormation error.

type ErrStackNotFound

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

ErrStackNotFound occurs when we can't find a particular CloudFormation stack.

func (*ErrStackNotFound) Error

func (err *ErrStackNotFound) Error() string

type ErrStackSetOutOfDate

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

ErrStackSetOutOfDate occurs when we try to read and then update a StackSet but between reading it and actually updating it, someone else either started or completed an update.

func (*ErrStackSetOutOfDate) Error

func (err *ErrStackSetOutOfDate) Error() string

func (*ErrStackSetOutOfDate) Is

func (err *ErrStackSetOutOfDate) Is(target error) bool

Is returns true if the target's template location and parent error are equal to this error's template location and parent error.

type ErrStackUpdateInProgress

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

ErrStackUpdateInProgress occurs when we try to update a stack that's already being updated.

func (*ErrStackUpdateInProgress) Error

func (err *ErrStackUpdateInProgress) Error() string

type ErrTemplateNotFound

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

ErrTemplateNotFound occurs when we can't find a predefined template.

func (*ErrTemplateNotFound) Error

func (err *ErrTemplateNotFound) Error() string

func (*ErrTemplateNotFound) Is

func (err *ErrTemplateNotFound) Is(target error) bool

Is returns true if the target's template location and parent error are equal to this error's template location and parent error.

func (*ErrTemplateNotFound) Unwrap

func (err *ErrTemplateNotFound) Unwrap() error

Unwrap returns the original error.

type Resource

type Resource struct {
	LogicalName string
	Type        string
}

Resource represents an AWS resource.

type ResourceEvent

type ResourceEvent struct {
	Resource
	Status       string
	StatusReason string
}

ResourceEvent represents a status update for an AWS resource during a deployment.

type StackStatus

type StackStatus string

StackStatus stacks

func (StackStatus) InProgress

func (s StackStatus) InProgress() bool

InProgress that the stack is currently being updated.

func (StackStatus) RequiresCleanup

func (s StackStatus) RequiresCleanup() bool

RequiresCleanup indicates that the stack was created, but failed. It should be deleted.