Skip to content
v2.276.0

StackInstancesProperty Struct ​

Stack instances in some specific accounts and Regions.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudformation as cloudformation } from 'aws-cdk-lib';
const stackInstancesProperty: cloudformation.CfnStackSet.StackInstancesProperty = {
  deploymentTargets: {
    accountFilterType: 'accountFilterType',
    accounts: ['accounts'],
    accountsUrl: 'accountsUrl',
    organizationalUnitIds: ['organizationalUnitIds'],
  },
  regions: ['regions'],

  // the properties below are optional
  parameterOverrides: [{
    parameterKey: 'parameterKey',
    parameterValue: 'parameterValue',
  }],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudformation as cloudformation

stack_instances_property = cloudformation.CfnStackSet.StackInstancesProperty(
    deployment_targets=cloudformation.CfnStackSet.DeploymentTargetsProperty(
        account_filter_type="accountFilterType",
        accounts=["accounts"],
        accounts_url="accountsUrl",
        organizational_unit_ids=["organizationalUnitIds"]
    ),
    regions=["regions"],

    # the properties below are optional
    parameter_overrides=[cloudformation.CfnStackSet.ParameterProperty(
        parameter_key="parameterKey",
        parameter_value="parameterValue"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cloudformation.*;

StackInstancesProperty stackInstancesProperty = StackInstancesProperty.builder()
        .deploymentTargets(DeploymentTargetsProperty.builder()
                .accountFilterType("accountFilterType")
                .accounts(List.of("accounts"))
                .accountsUrl("accountsUrl")
                .organizationalUnitIds(List.of("organizationalUnitIds"))
                .build())
        .regions(List.of("regions"))

        // the properties below are optional
        .parameterOverrides(List.of(ParameterProperty.builder()
                .parameterKey("parameterKey")
                .parameterValue("parameterValue")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFormation;

var stackInstancesProperty = new StackInstancesProperty {
    DeploymentTargets = new DeploymentTargetsProperty {
        AccountFilterType = "accountFilterType",
        Accounts = new [] { "accounts" },
        AccountsUrl = "accountsUrl",
        OrganizationalUnitIds = new [] { "organizationalUnitIds" }
    },
    Regions = new [] { "regions" },

    // the properties below are optional
    ParameterOverrides = new [] { new ParameterProperty {
        ParameterKey = "parameterKey",
        ParameterValue = "parameterValue"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

stackInstancesProperty := &StackInstancesProperty{
	DeploymentTargets: &DeploymentTargetsProperty{
		AccountFilterType: jsii.String("accountFilterType"),
		Accounts: []*string{
			jsii.String("accounts"),
		},
		AccountsUrl: jsii.String("accountsUrl"),
		OrganizationalUnitIds: []*string{
			jsii.String("organizationalUnitIds"),
		},
	},
	Regions: []*string{
		jsii.String("regions"),
	},

	// the properties below are optional
	ParameterOverrides: []interface{}{
		&ParameterProperty{
			ParameterKey: jsii.String("parameterKey"),
			ParameterValue: jsii.String("parameterValue"),
		},
	},
}

Properties ​

deploymentTargetsIResolvable | CfnStackSet.DeploymentTargetsPropertydeployment_targetstyping.Union[IResolvable, DeploymentTargetsProperty]deploymentTargetsIResolvableDeploymentTargetsIResolvableDeploymentTargetsinterface{}required#
The AWS Organizations accounts or AWS accounts to deploy stacks to in the specified Regions.
parameterOverridesoptionalIResolvable | IResolvable | CfnStackSet.ParameterProperty[]parameter_overridesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ParameterProperty]]]parameterOverridesoptionalIResolvableParameterOverridesoptionalIResolvableParameterOverridesoptionalinterface{}#
A list of StackSet parameters whose values you want to override in the selected stack instances.
regionsstring[]regionstyping.List[str]regionsList<String>Regionsstring[]Regions*[]*stringrequired#
The names of one or more Regions where you want to create stack instances using the specified AWS accounts .