Show / Hide Table of Contents

Class CfnStackSet.DeploymentTargetsProperty

The AWS Organizations accounts or AWS accounts to deploy stacks to in the specified Regions.

Inheritance
object
CfnStackSet.DeploymentTargetsProperty
Implements
CfnStackSet.IDeploymentTargetsProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStackSet.DeploymentTargetsProperty : CfnStackSet.IDeploymentTargetsProperty
Syntax (vb)
Public Class CfnStackSet.DeploymentTargetsProperty Implements CfnStackSet.IDeploymentTargetsProperty
Remarks

When deploying to AWS Organizations accounts with SERVICE_MANAGED permissions:

    When deploying to AWS accounts with SELF_MANAGED permissions:

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html

      ExampleMetadata: fixture=_generated

      Examples
      // The code below shows an example of how to instantiate this type.
                   // The values are placeholders you should change.
                   using Amazon.CDK;
      
                   var deploymentTargetsProperty = new DeploymentTargetsProperty {
                       AccountFilterType = "accountFilterType",
                       Accounts = new [] { "accounts" },
                       AccountsUrl = "accountsUrl",
                       OrganizationalUnitIds = new [] { "organizationalUnitIds" }
                   };

      Synopsis

      Constructors

      DeploymentTargetsProperty()

      The AWS Organizations accounts or AWS accounts to deploy stacks to in the specified Regions.

      Properties

      AccountFilterType

      Refines which accounts to deploy stacks to by specifying how to use the Accounts and OrganizationalUnitIds properties together.

      Accounts

      The account IDs of the AWS accounts .

      AccountsUrl

      The Amazon S3 URL path to a file that contains a list of AWS account IDs.

      OrganizationalUnitIds

      The organization root ID or organizational unit (OU) IDs.

      Constructors

      DeploymentTargetsProperty()

      The AWS Organizations accounts or AWS accounts to deploy stacks to in the specified Regions.

      public DeploymentTargetsProperty()
      Remarks

      When deploying to AWS Organizations accounts with SERVICE_MANAGED permissions:

        When deploying to AWS accounts with SELF_MANAGED permissions:

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html

          ExampleMetadata: fixture=_generated

          Examples
          // The code below shows an example of how to instantiate this type.
                       // The values are placeholders you should change.
                       using Amazon.CDK;
          
                       var deploymentTargetsProperty = new DeploymentTargetsProperty {
                           AccountFilterType = "accountFilterType",
                           Accounts = new [] { "accounts" },
                           AccountsUrl = "accountsUrl",
                           OrganizationalUnitIds = new [] { "organizationalUnitIds" }
                       };

          Properties

          AccountFilterType

          Refines which accounts to deploy stacks to by specifying how to use the Accounts and OrganizationalUnitIds properties together.

          public string? AccountFilterType { get; set; }
          Property Value

          string

          Remarks

          The following values determine how CloudFormation selects target accounts:

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountfiltertype

            Accounts

            The account IDs of the AWS accounts .

            public string[]? Accounts { get; set; }
            Property Value

            string[]

            Remarks

            If you have many account numbers, you can provide those accounts using the AccountsUrl property instead.

            Pattern : ^[0-9]{12}$

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accounts

            AccountsUrl

            The Amazon S3 URL path to a file that contains a list of AWS account IDs.

            public string? AccountsUrl { get; set; }
            Property Value

            string

            Remarks

            The file format must be either .csv or .txt , and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).

            This property serves the same purpose as Accounts but allows you to specify a large number of accounts.

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountsurl

            OrganizationalUnitIds

            The organization root ID or organizational unit (OU) IDs.

            public string[]? OrganizationalUnitIds { get; set; }
            Property Value

            string[]

            Remarks

            Pattern : ^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-organizationalunitids

            Implements

            CfnStackSet.IDeploymentTargetsProperty
            Back to top Generated by DocFX