Class: Aws::CloudFormation::Types::DeploymentTargets

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass DeploymentTargets data as a hash:

{
  accounts: ["Account"],
  accounts_url: "AccountsUrl",
  organizational_unit_ids: ["OrganizationalUnitId"],
  account_filter_type: "NONE", # accepts NONE, INTERSECTION, DIFFERENCE, UNION
}

[Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.

For update operations, you can specify either `Accounts` or `OrganizationalUnitIds`. For create and delete operations, specify `OrganizationalUnitIds`.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_filter_typeString

Limit deployment targets to individual accounts or include additional accounts with provided OUs.

The following is a list of possible values for the `AccountFilterType` operation.

  • `INTERSECTION`: StackSets deploys to the accounts specified in `Accounts` parameter.

  • `DIFFERENCE`: StackSets excludes the accounts specified in `Accounts` parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.

  • `UNION`: (default value) StackSets includes additional accounts deployment targets.

    This is the default value if `AccountFilterType` is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.

  • `NONE`: Deploys to all the accounts in specified organizational units (OU).

Returns:

  • (String)

2312
2313
2314
2315
2316
2317
2318
2319
# File 'lib/aws-sdk-cloudformation/types.rb', line 2312

class DeploymentTargets < Struct.new(
  :accounts,
  :accounts_url,
  :organizational_unit_ids,
  :account_filter_type)
  SENSITIVE = []
  include Aws::Structure
end

#accountsArray<String>

The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

Returns:

  • (Array<String>)

2312
2313
2314
2315
2316
2317
2318
2319
# File 'lib/aws-sdk-cloudformation/types.rb', line 2312

class DeploymentTargets < Struct.new(
  :accounts,
  :accounts_url,
  :organizational_unit_ids,
  :account_filter_type)
  SENSITIVE = []
  include Aws::Structure
end

#accounts_urlString

Returns the value of the `AccountsUrl` property.

Returns:

  • (String)

2312
2313
2314
2315
2316
2317
2318
2319
# File 'lib/aws-sdk-cloudformation/types.rb', line 2312

class DeploymentTargets < Struct.new(
  :accounts,
  :accounts_url,
  :organizational_unit_ids,
  :account_filter_type)
  SENSITIVE = []
  include Aws::Structure
end

#organizational_unit_idsArray<String>

The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

Returns:

  • (Array<String>)

2312
2313
2314
2315
2316
2317
2318
2319
# File 'lib/aws-sdk-cloudformation/types.rb', line 2312

class DeploymentTargets < Struct.new(
  :accounts,
  :accounts_url,
  :organizational_unit_ids,
  :account_filter_type)
  SENSITIVE = []
  include Aws::Structure
end