CreateStackInstancesRequest (AWS SDK for Java

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateStackInstancesRequest.Builder,CreateStackInstancesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateStackInstancesRequest
extends CloudFormationRequest
implements ToCopyableBuilder<CreateStackInstancesRequest.Builder,CreateStackInstancesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateStackInstancesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateStackInstancesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`accounts()` The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
`static CreateStackInstancesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`operationId()` The unique identifier for this stack set operation.
`StackSetOperationPreferences`	`operationPreferences()` Preferences for how AWS CloudFormation performs this stack set operation.
`List<Parameter>`	`parameterOverrides()` A list of stack set parameters whose values you want to override in the selected stack instances.
`List<String>`	`regions()` The names of one or more regions where you want to create stack instances using the specified AWS account(s).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateStackInstancesRequest.Builder>`	`serializableBuilderClass()`
`String`	`stackSetName()` The name or unique ID of the stack set that you want to create stack instances from.
`CreateStackInstancesRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - stackSetName
```
public 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.
  - accounts
```
public List<String> accounts()
```
    The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
  - regions
```
public List<String> regions()
```
    The names of one or more regions where you want to create stack instances using the specified AWS account(s).
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The names of one or more regions where you want to create stack instances using the specified AWS account(s).
  - parameterOverrides
```
public 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 regions. When specifying parameters and their values, be aware of how AWS 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 a parameter set to its present value, you can do one of the following:
      
      Do not include the parameter in the list.
      
      Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)
    - To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.
    - To leave all parameters set to their present values, do not specify this property at all.
    During stack set updates, any parameter values overridden for a stack instance are not 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.
    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 regions. When specifying parameters and their values, be aware of how AWS 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 a parameter set to its present value, you can do one of the following:
    
    Do not include the parameter in the list.
    
    Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)
    
    To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.
    
    To leave all parameters set to their present values, do not specify this property at all.
    
    During stack set updates, any parameter values overridden for a stack instance are not 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 StackSetOperationPreferences operationPreferences()
```
    Preferences for how AWS CloudFormation performs this stack set operation.
    
    Returns:
    
    Preferences for how AWS CloudFormation performs this stack set operation.
  - operationId
```
public String operationId()
```
    The unique identifier for this stack set operation.
    
    The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS 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 AWS 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 AWS 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.
  - toBuilder
```
public CreateStackInstancesRequest.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<CreateStackInstancesRequest.Builder,CreateStackInstancesRequest>
    
    Specified by:
    
    toBuilder in class CloudFormationRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateStackInstancesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateStackInstancesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

Class CreateStackInstancesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

stackSetName

accounts

regions

parameterOverrides

operationPreferences

operationId

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields