amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.Types.DeploymentTargets

Description

 
Synopsis

Documentation

data DeploymentTargets Source #

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.

See: newDeploymentTargets smart constructor.

Constructors

DeploymentTargets' 

Fields

  • accountFilterType :: Maybe AccountFilterType

    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: 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).
  • accounts :: Maybe [Text]

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

  • accountsUrl :: Maybe Text

    Returns the value of the AccountsUrl property.

  • organizationalUnitIds :: Maybe [Text]

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

Instances

Instances details
ToQuery DeploymentTargets Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.DeploymentTargets

FromXML DeploymentTargets Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.DeploymentTargets

Generic DeploymentTargets Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.DeploymentTargets

Associated Types

type Rep DeploymentTargets :: Type -> Type #

Read DeploymentTargets Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.DeploymentTargets

Show DeploymentTargets Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.DeploymentTargets

NFData DeploymentTargets Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.DeploymentTargets

Methods

rnf :: DeploymentTargets -> () #

Eq DeploymentTargets Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.DeploymentTargets

Hashable DeploymentTargets Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.DeploymentTargets

type Rep DeploymentTargets Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.DeploymentTargets

type Rep DeploymentTargets = D1 ('MetaData "DeploymentTargets" "Amazonka.CloudFormation.Types.DeploymentTargets" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DeploymentTargets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountFilterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccountFilterType)) :*: S1 ('MetaSel ('Just "accounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "accountsUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "organizationalUnitIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDeploymentTargets :: DeploymentTargets Source #

Create a value of DeploymentTargets with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountFilterType:DeploymentTargets', deploymentTargets_accountFilterType - 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: 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).

$sel:accounts:DeploymentTargets', deploymentTargets_accounts - The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

$sel:accountsUrl:DeploymentTargets', deploymentTargets_accountsUrl - Returns the value of the AccountsUrl property.

$sel:organizationalUnitIds:DeploymentTargets', deploymentTargets_organizationalUnitIds - The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

deploymentTargets_accountFilterType :: Lens' DeploymentTargets (Maybe AccountFilterType) Source #

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: 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).

deploymentTargets_accounts :: Lens' DeploymentTargets (Maybe [Text]) Source #

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

deploymentTargets_accountsUrl :: Lens' DeploymentTargets (Maybe Text) Source #

Returns the value of the AccountsUrl property.

deploymentTargets_organizationalUnitIds :: Lens' DeploymentTargets (Maybe [Text]) Source #

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