stackset

Documentation

Index

• type AutoDeployment
  • func (strct *AutoDeployment) MarshalJSON() ([]byte, error)
  • func (strct *AutoDeployment) UnmarshalJSON(b []byte) error
• type DeploymentTargets
  • func (strct *DeploymentTargets) MarshalJSON() ([]byte, error)
  • func (strct *DeploymentTargets) UnmarshalJSON(b []byte) error
• type ManagedExecution
  • func (strct *ManagedExecution) MarshalJSON() ([]byte, error)
  • func (strct *ManagedExecution) UnmarshalJSON(b []byte) error
• type OperationPreferences
  • func (strct *OperationPreferences) MarshalJSON() ([]byte, error)
  • func (strct *OperationPreferences) UnmarshalJSON(b []byte) error
• type Parameter
  • func (strct *Parameter) MarshalJSON() ([]byte, error)
  • func (strct *Parameter) UnmarshalJSON(b []byte) error
• type Resource
  • func (strct *Resource) MarshalJSON() ([]byte, error)
  • func (strct *Resource) UnmarshalJSON(b []byte) error
• type StackInstances
  • func (strct *StackInstances) MarshalJSON() ([]byte, error)
  • func (strct *StackInstances) UnmarshalJSON(b []byte) error
• type Tag
  • func (strct *Tag) MarshalJSON() ([]byte, error)
  • func (strct *Tag) UnmarshalJSON(b []byte) error

Types

type AutoDeployment

type AutoDeployment struct {

	// If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
	Enabled bool `json:"Enabled,omitempty"`

	// If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.
	RetainStacksOnAccountRemoval bool `json:"RetainStacksOnAccountRemoval,omitempty"`
}

AutoDeployment

func (*AutoDeployment) MarshalJSON

func (strct *AutoDeployment) MarshalJSON() ([]byte, error)

func (*AutoDeployment) UnmarshalJSON

func (strct *AutoDeployment) UnmarshalJSON(b []byte) error

type DeploymentTargets

type DeploymentTargets struct {

	// The filter type you want to apply on organizational units and accounts.
	AccountFilterType string `json:"AccountFilterType,omitempty"`

	// AWS accounts that you want to create stack instances in the specified Region(s) for.
	Accounts []string `json:"Accounts,omitempty"`

	// The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
	OrganizationalUnitIds []string `json:"OrganizationalUnitIds,omitempty"`
}

DeploymentTargets The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.

func (*DeploymentTargets) MarshalJSON

func (strct *DeploymentTargets) MarshalJSON() ([]byte, error)

func (*DeploymentTargets) UnmarshalJSON

func (strct *DeploymentTargets) UnmarshalJSON(b []byte) error

type ManagedExecution

type ManagedExecution struct {
	Active bool `json:"Active,omitempty"`
}

ManagedExecution Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

func (*ManagedExecution) MarshalJSON

func (strct *ManagedExecution) MarshalJSON() ([]byte, error)

func (*ManagedExecution) UnmarshalJSON

func (strct *ManagedExecution) UnmarshalJSON(b []byte) error

type OperationPreferences

type OperationPreferences struct {
	FailureToleranceCount      int      `json:"FailureToleranceCount,omitempty"`
	FailureTolerancePercentage int      `json:"FailureTolerancePercentage,omitempty"`
	MaxConcurrentCount         int      `json:"MaxConcurrentCount,omitempty"`
	MaxConcurrentPercentage    int      `json:"MaxConcurrentPercentage,omitempty"`
	RegionConcurrencyType      string   `json:"RegionConcurrencyType,omitempty"`
	RegionOrder                []string `json:"RegionOrder,omitempty"`
}

OperationPreferences The user-specified preferences for how AWS CloudFormation performs a stack set operation.

func (*OperationPreferences) MarshalJSON

func (strct *OperationPreferences) MarshalJSON() ([]byte, error)

func (*OperationPreferences) UnmarshalJSON

func (strct *OperationPreferences) UnmarshalJSON(b []byte) error

type Parameter

type Parameter struct {

	// The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
	ParameterKey string `json:"ParameterKey"`

	// The input value associated with the parameter.
	ParameterValue string `json:"ParameterValue"`
}

Parameter

func (*Parameter) MarshalJSON

func (strct *Parameter) MarshalJSON() ([]byte, error)

func (*Parameter) UnmarshalJSON

func (strct *Parameter) UnmarshalJSON(b []byte) error

type Resource

type Resource struct {

	// The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
	AdministrationRoleARN string `json:"AdministrationRoleARN,omitempty"`

	// Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
	AutoDeployment *AutoDeployment `json:"AutoDeployment,omitempty"`

	// Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	CallAs string `json:"CallAs,omitempty"`

	// In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
	Capabilities []string `json:"Capabilities,omitempty"`

	// A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
	Description string `json:"Description,omitempty"`

	// The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
	ExecutionRoleName string `json:"ExecutionRoleName,omitempty"`

	// Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
	ManagedExecution     *ManagedExecution     `json:"ManagedExecution,omitempty"`
	OperationPreferences *OperationPreferences `json:"OperationPreferences,omitempty"`

	// The input parameters for the stack set template.
	Parameters []*Parameter `json:"Parameters,omitempty"`

	// Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
	PermissionModel string `json:"PermissionModel"`

	// A group of stack instances with parameters in some specific accounts and regions.
	StackInstancesGroup []*StackInstances `json:"StackInstancesGroup,omitempty"`

	// The ID of the stack set that you're creating.
	StackSetId string `json:"StackSetId,omitempty"`

	// The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
	StackSetName string `json:"StackSetName"`

	// The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
	Tags []*Tag `json:"Tags,omitempty"`

	// The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
	TemplateBody string `json:"TemplateBody,omitempty"`

	// Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
	TemplateURL string `json:"TemplateURL,omitempty"`
}

Resource StackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances

func (*Resource) MarshalJSON

func (strct *Resource) MarshalJSON() ([]byte, error)

func (*Resource) UnmarshalJSON

func (strct *Resource) UnmarshalJSON(b []byte) error

type StackInstances

type StackInstances struct {
	DeploymentTargets *DeploymentTargets `json:"DeploymentTargets"`

	// A list of stack set parameters whose values you want to override in the selected stack instances.
	ParameterOverrides []*Parameter `json:"ParameterOverrides,omitempty"`

	// The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
	Regions []string `json:"Regions"`
}

StackInstances Stack instances in some specific accounts and Regions.

func (*StackInstances) MarshalJSON

func (strct *StackInstances) MarshalJSON() ([]byte, error)

func (*StackInstances) UnmarshalJSON

func (strct *StackInstances) UnmarshalJSON(b []byte) error

type Tag

type Tag struct {

	// A string used to identify this tag. You can specify a maximum of 127 characters for a tag key.
	Key string `json:"Key"`

	// A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
	Value string `json:"Value"`
}

Tag Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation StackSet.

func (*Tag) MarshalJSON

func (strct *Tag) MarshalJSON() ([]byte, error)

func (*Tag) UnmarshalJSON

func (strct *Tag) UnmarshalJSON(b []byte) error