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

Class CreateStackSetRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
software.amazon.awssdk.services.cloudformation.model.CreateStackSetRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateStackSetRequest.Builder,CreateStackSetRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateStackSetRequest extends CloudFormationRequest implements ToCopyableBuilder<CreateStackSetRequest.Builder,CreateStackSetRequest>

  • Method Details

    • stackSetName

      public final String stackSetName()

      The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

      A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

      Returns:
      The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

      A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

    • description

      public final String description()

      A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

      Returns:
      A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

    • templateBody

      public final String templateBody()

      The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

      Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

      Returns:
      The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

      Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

    • templateURL

      public final String templateURL()

      The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

      Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

      Returns:
      The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

      Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

    • stackId

      public final String stackId()

      The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

      Returns:
      The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters 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.

    • parameters

      public final List<Parameter> parameters()

      The input parameters for 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 hasParameters() method.

      Returns:
      The input parameters for the stack set template.

    • capabilities

      public final List<Capability> capabilities()

      In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

      • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

        Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

        The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

        • If you have IAM resources, you can specify either capability.

        • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

        • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

        If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

        For more information, see Acknowledging IAM Resources in CloudFormation Templates.

      • CAPABILITY_AUTO_EXPAND

        Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

        Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

      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 hasCapabilities() method.

      Returns:
      In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

      • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

        Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

        The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

        • If you have IAM resources, you can specify either capability.

        • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

        • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

        If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

        For more information, see Acknowledging IAM Resources in CloudFormation Templates.

      • CAPABILITY_AUTO_EXPAND

        Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

        Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

    • hasCapabilities

      public final boolean hasCapabilities()
      For responses, this returns true if the service returned a value for the Capabilities 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.

    • capabilitiesAsStrings

      public final List<String> capabilitiesAsStrings()

      In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

      • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

        Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

        The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

        • If you have IAM resources, you can specify either capability.

        • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

        • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

        If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

        For more information, see Acknowledging IAM Resources in CloudFormation Templates.

      • CAPABILITY_AUTO_EXPAND

        Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

        Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

      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 hasCapabilities() method.

      Returns:
      In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

      • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

        Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

        The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

        • If you have IAM resources, you can specify either capability.

        • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

        • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

        If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

        For more information, see Acknowledging IAM Resources in CloudFormation Templates.

      • CAPABILITY_AUTO_EXPAND

        Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

        Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

      If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

      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 hasTags() method.

      Returns:
      The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

      If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

    • administrationRoleARN

      public final String administrationRoleARN()

      The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

      Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

      Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

    • executionRoleName

      public final String executionRoleName()

      The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

      Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

      Returns:
      The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

      Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

    • permissionModel

      public final PermissionModels permissionModel()

      Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

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

      Returns:
      Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

      See Also:

    • permissionModelAsString

      public final String permissionModelAsString()

      Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

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

      Returns:
      Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

      See Also:

    • autoDeployment

      public final AutoDeployment autoDeployment()

      Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

      Returns:
      Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

    • 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.

      • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

      • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

      Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

      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.

      • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

      • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

      Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

      See Also:

    • 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.

      • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

      • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

      Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

      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.

      • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

      • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

      Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

      See Also:

    • clientRequestToken

      public final String clientRequestToken()

      A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.

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

      Returns:
      A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.

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

    • managedExecution

      public final ManagedExecution managedExecution()

      Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

      Returns:
      Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

    • toBuilder

      public CreateStackSetRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateStackSetRequest.Builder,CreateStackSetRequest>
      Specified by:
      toBuilder in class CloudFormationRequest
      Returns:
      a builder for type T

    • builder

      public static CreateStackSetRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateStackSetRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.