Package software.amazon.awssdk.services.cloudformation.model

Class CreateStackInstancesRequest

    • Method Detail

      • stackSetName

        public final String stackSetName()

        The name or unique ID of the stack set that you want to create stack instances from.

        Returns:
        The name or unique ID of the stack set that you want to create stack instances from.

      • hasAccounts

        public final boolean hasAccounts()
        For responses, this returns true if the service returned a value for the Accounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • accounts

        public final List<String> accounts()

        [Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

        You can specify Accounts or DeploymentTargets, but not both.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccounts() method.

        Returns:
        [Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

        You can specify Accounts or DeploymentTargets, but not both.

      • deploymentTargets

        public final DeploymentTargets deploymentTargets()

        [Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.

        You can specify Accounts or DeploymentTargets, but not both.

        Returns:
        [Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.

        You can specify Accounts or DeploymentTargets, but not both.

      • hasRegions

        public final boolean hasRegions()
        For responses, this returns true if the service returned a value for the Regions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • regions

        public final List<String> regions()

        The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegions() method.

        Returns:
        The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

      • hasParameterOverrides

        public final boolean hasParameterOverrides()
        For responses, this returns true if the service returned a value for the ParameterOverrides property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • parameterOverrides

        public final List<Parameter> parameterOverrides()

        A list of stack set parameters whose values you want to override in the selected stack instances.

        Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

        • To override the current value for a parameter, include the parameter and specify its value.

        • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)

        • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.

        • To leave all parameters set to their present values, don't specify this property at all.

        During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

        You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameterOverrides() method.

        Returns:
        A list of stack set parameters whose values you want to override in the selected stack instances.

        Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

        • To override the current value for a parameter, include the parameter and specify its value.

        • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)

        • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.

        • To leave all parameters set to their present values, don't specify this property at all.

        During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

        You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

      • operationPreferences

        public final StackSetOperationPreferences operationPreferences()

        Preferences for how CloudFormation performs this stack set operation.

        Returns:
        Preferences for how CloudFormation performs this stack set operation.

      • operationId

        public final String operationId()

        The unique identifier for this stack set operation.

        The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

        If you don't specify an operation ID, the SDK generates one automatically.

        Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

        Returns:
        The unique identifier for this stack set operation.

        The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

        If you don't specify an operation ID, the SDK generates one automatically.

        Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

      • callAs

        public final CallAs callAs()

        [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

        By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

        • If you are signed in to the management account, specify SELF.

        • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

          Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

        If the service returns an enum value that is not available in the current SDK version, callAs will return CallAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAsAsString().

        Returns:
        [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

        By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

        • If you are signed in to the management account, specify SELF.

        • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

          Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

        See Also:
        CallAs

      • callAsAsString

        public final String callAsAsString()

        [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

        By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

        • If you are signed in to the management account, specify SELF.

        • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

          Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

        If the service returns an enum value that is not available in the current SDK version, callAs will return CallAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAsAsString().

        Returns:
        [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

        By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

        • If you are signed in to the management account, specify SELF.

        • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

          Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

        See Also:
        CallAs

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object