stack

Documentation

Overview

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

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

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

Index

• Constants
• type ComponentStackConfig
  • func NewComponentStackConfig(input *types.ComponentInput, box packd.Box) *ComponentStackConfig
  • func (e *ComponentStackConfig) Parameters() []*cloudformation.Parameter
  • func (e *ComponentStackConfig) StackName() string
  • func (e *ComponentStackConfig) Tags() []*cloudformation.Tag
  • func (e *ComponentStackConfig) Template() (string, error)
  • func (e *ComponentStackConfig) ToComponent(stack *cloudformation.Stack) (*types.Component, error)
• type EnvStackConfig
  • func NewEnvStackConfig(input *types.EnvironmentInput, box packd.Box) *EnvStackConfig
  • func (e *EnvStackConfig) Parameters() []*cloudformation.Parameter
  • func (e *EnvStackConfig) StackName() string
  • func (e *EnvStackConfig) Tags() []*cloudformation.Tag
  • func (e *EnvStackConfig) Template() (string, error)
  • func (e *EnvStackConfig) ToEnv(stack *cloudformation.Stack) (*types.Environment, error)
• type ErrTemplateNotFound
  • func (err *ErrTemplateNotFound) Error() string
  • func (err *ErrTemplateNotFound) Is(target error) bool
  • func (err *ErrTemplateNotFound) Unwrap() error

Constants

const (
	EnvTagKey       = "oam-ecs-environment"
	EnvTagValue     = "default"
	AppTagKey       = "oam-ecs-application"
	ComponentTagKey = "oam-ecs-component"
)

Tag keys used while creating stacks.

const (
	// EnvTemplatePath is the path where the cloudformation for the environment is written.
	EnvTemplatePath = "environment/cf.yml"
)

Types

type ComponentStackConfig

type ComponentStackConfig struct {
	*types.ComponentInput
	// contains filtered or unexported fields
}

ComponentStackConfig is for providing all the values to set up an component instance stack and to interpret the outputs from it.

func NewComponentStackConfig

func NewComponentStackConfig(input *types.ComponentInput, box packd.Box) *ComponentStackConfig

NewComponentStackConfig sets up a struct which can provide values to CloudFormation for spinning up a component instance.

func (*ComponentStackConfig) Parameters

func (e *ComponentStackConfig) Parameters() []*cloudformation.Parameter

Parameters returns the parameters to be passed into a component instance CloudFormation template.

func (*ComponentStackConfig) StackName

func (e *ComponentStackConfig) StackName() string

StackName returns the name of the CloudFormation stack (hard-coded).

func (*ComponentStackConfig) Tags

func (e *ComponentStackConfig) Tags() []*cloudformation.Tag

Tags returns the tags that should be applied to the component instance CloudFormation stack.

func (*ComponentStackConfig) Template

func (e *ComponentStackConfig) Template() (string, error)

Template returns the component instance CloudFormation template.

func (*ComponentStackConfig) ToComponent

func (e *ComponentStackConfig) ToComponent(stack *cloudformation.Stack) (*types.Component, error)

ToComponent inspects a component instance cloudformation stack and constructs a component instance struct out of it

type EnvStackConfig

type EnvStackConfig struct {
	*types.EnvironmentInput
	// contains filtered or unexported fields
}

EnvStackConfig is for providing all the values to set up an environment stack and to interpret the outputs from it.

func NewEnvStackConfig

func NewEnvStackConfig(input *types.EnvironmentInput, box packd.Box) *EnvStackConfig

NewEnvStackConfig sets up a struct which can provide values to CloudFormation for spinning up an environment.

func (*EnvStackConfig) Parameters

func (e *EnvStackConfig) Parameters() []*cloudformation.Parameter

Parameters returns the parameters to be passed into a environment CloudFormation template.

func (*EnvStackConfig) StackName

func (e *EnvStackConfig) StackName() string

StackName returns the name of the CloudFormation stack (hard-coded).

func (*EnvStackConfig) Tags

func (e *EnvStackConfig) Tags() []*cloudformation.Tag

Tags returns the tags that should be applied to the environment CloudFormation stack.

func (*EnvStackConfig) Template

func (e *EnvStackConfig) Template() (string, error)

Template returns the environment CloudFormation template.

func (*EnvStackConfig) ToEnv

func (e *EnvStackConfig) ToEnv(stack *cloudformation.Stack) (*types.Environment, error)

ToEnv inspects an environment cloudformation stack and constructs an environment struct out of it

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.