CreateStackRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.opsworks.model.OpsWorksRequest
    - - software.amazon.awssdk.services.opsworks.model.CreateStackRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateStackRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`agentVersion()` The default AWS OpsWorks Stacks agent version.
`Map<StackAttributesKeys,String>`	`attributes()` One or more user-defined key-value pairs to be added to the stack attributes.
`Map<String,String>`	`attributesAsStrings()` One or more user-defined key-value pairs to be added to the stack attributes.
`static CreateStackRequest.Builder`	`builder()`
`ChefConfiguration`	`chefConfiguration()` A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
`StackConfigurationManager`	`configurationManager()` The configuration manager.
`Source`	`customCookbooksSource()` Returns the value of the CustomCookbooksSource property for this object.
`String`	`customJson()` A string that contains user-defined, custom JSON.
`String`	`defaultAvailabilityZone()` The stack's default Availability Zone, which must be in the specified region.
`String`	`defaultInstanceProfileArn()` The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.
`String`	`defaultOs()` The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.
`RootDeviceType`	`defaultRootDeviceType()` The default root device type.
`String`	`defaultRootDeviceTypeAsString()` The default root device type.
`String`	`defaultSshKeyName()` A default Amazon EC2 key pair name.
`String`	`defaultSubnetId()` The stack's default VPC subnet ID.
`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`	`hostnameTheme()` The stack's host name theme, with spaces replaced by underscores.
`String`	`name()` The stack name.
`String`	`region()` The stack's AWS region, such as `ap-south-1`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateStackRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceRoleArn()` The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf.
`CreateStackRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Boolean`	`useCustomCookbooks()` Whether the stack uses custom cookbooks.
`Boolean`	`useOpsworksSecurityGroups()` Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
`String`	`vpcId()` The ID of the VPC that the stack is to be launched into.

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
  - name
```
public String name()
```
    The stack name.
    
    Returns:
    
    The stack name.
  - region
```
public String region()
```
    The stack's AWS region, such as ap-south-1. For more information about Amazon regions, see Regions and Endpoints.
    
    In the AWS CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the AWS CLI common parameter --region are set to the same value, the stack uses a regional endpoint. If the --stack-region parameter is not set, but the AWS CLI --region parameter is, this also results in a stack with a regional endpoint. However, if the --region parameter is set to us-east-1, and the --stack-region parameter is set to one of the following, then the stack uses a legacy or classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2 . In this case, the actual API endpoint of the stack is in us-east-1. Only the preceding regions are supported as classic regions in the us-east-1 API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for new stacks. The AWS CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic AWS OpsWorks Stacks region.
    
    Returns:
    
    The stack's AWS region, such as ap-south-1. For more information about Amazon regions, see Regions and Endpoints.
    
    In the AWS CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the AWS CLI common parameter --region are set to the same value, the stack uses a regional endpoint. If the --stack-region parameter is not set, but the AWS CLI --region parameter is, this also results in a stack with a regional endpoint. However, if the --region parameter is set to us-east-1, and the --stack-region parameter is set to one of the following, then the stack uses a legacy or classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2 . In this case, the actual API endpoint of the stack is in us-east-1. Only the preceding regions are supported as classic regions in the us-east-1 API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for new stacks. The AWS CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic AWS OpsWorks Stacks region.
  - vpcId
```
public String vpcId()
```
    The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.
    - If your account supports EC2-Classic, the default value is no VPC.
    - If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
    If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
    
    If you specify a nondefault VPC ID, note the following:
    - It must belong to a VPC in your account that is in the specified region.
    - You must specify a value for DefaultSubnetId.
    For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.
    Returns:
    The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.
    
    If your account supports EC2-Classic, the default value is no VPC.
    
    If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
    
    If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
    
    If you specify a nondefault VPC ID, note the following:
    
    It must belong to a VPC in your account that is in the specified region.
    
    You must specify a value for DefaultSubnetId.
    
    For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.
  - attributes
```
public Map<StackAttributesKeys,String> attributes()
```
    One or more user-defined key-value pairs to be added to the stack attributes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more user-defined key-value pairs to be added to the stack attributes.
  - attributesAsStrings
```
public Map<String,String> attributesAsStrings()
```
    One or more user-defined key-value pairs to be added to the stack attributes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more user-defined key-value pairs to be added to the stack attributes.
  - serviceRoleArn
```
public String serviceRoleArn()
```
    The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
    
    Returns:
    
    The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
  - defaultInstanceProfileArn
```
public String defaultInstanceProfileArn()
```
    The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
  - defaultOs
```
public String defaultOs()
```
    The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
    - A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
    - A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
    - CentOS Linux 7
    - Red Hat Enterprise Linux 7
    - A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
    - A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
    The default option is the current Amazon Linux version. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
    Returns:
    The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
    
    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
    
    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS , or Ubuntu 12.04 LTS.
    
    CentOS Linux 7
    
    Red Hat Enterprise Linux 7
    
    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
    
    A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
    
    The default option is the current Amazon Linux version. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
  - hostnameTheme
```
public String hostnameTheme()
```
    The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
    - Baked_Goods
    - Clouds
    - Europe_Cities
    - Fruits
    - Greek_Deities
    - Legendary_creatures_from_Japan
    - Planets_and_Moons
    - Roman_Deities
    - Scottish_Islands
    - US_Cities
    - Wild_Cats
    To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
    Returns:
    The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
    
    Baked_Goods
    
    Clouds
    
    Europe_Cities
    
    Fruits
    
    Greek_Deities
    
    Legendary_creatures_from_Japan
    
    Planets_and_Moons
    
    Roman_Deities
    
    Scottish_Islands
    
    US_Cities
    
    Wild_Cats
    
    To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
  - defaultAvailabilityZone
```
public String defaultAvailabilityZone()
```
    The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.
    
    Returns:
    
    The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.
  - defaultSubnetId
```
public String defaultSubnetId()
```
    The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
    
    Returns:
    
    The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
  - customJson
```
public String customJson()
```
    A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:
    
    "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
    
    For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
    
    Returns:
    
    A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:
    
    "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
    
    For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
  - configurationManager
```
public StackConfigurationManager configurationManager()
```
    The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
    
    Returns:
    
    The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
  - chefConfiguration
```
public ChefConfiguration chefConfiguration()
```
    A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
    
    Returns:
    
    A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
  - useCustomCookbooks
```
public Boolean useCustomCookbooks()
```
    Whether the stack uses custom cookbooks.
    
    Returns:
    
    Whether the stack uses custom cookbooks.
  - useOpsworksSecurityGroups
```
public Boolean useOpsworksSecurityGroups()
```
    Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
    
    AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
    - True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
    - False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
    For more information, see Create a New Stack.
    Returns:
    Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
    
    AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
    
    True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
    
    False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
    
    For more information, see Create a New Stack.
  - customCookbooksSource
```
public Source customCookbooksSource()
```
    Returns the value of the CustomCookbooksSource property for this object.
    
    Returns:
    
    The value of the CustomCookbooksSource property for this object.
  - defaultSshKeyName
```
public String defaultSshKeyName()
```
    A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
    
    Returns:
    
    A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
  - defaultRootDeviceType
```
public RootDeviceType defaultRootDeviceType()
```
    The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.
    
    If the service returns an enum value that is not available in the current SDK version, defaultRootDeviceType will return RootDeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultRootDeviceTypeAsString().
    
    Returns:
    
    The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.
    
    See Also:
    
    RootDeviceType
  - defaultRootDeviceTypeAsString
```
public String defaultRootDeviceTypeAsString()
```
    The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.
    
    If the service returns an enum value that is not available in the current SDK version, defaultRootDeviceType will return RootDeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultRootDeviceTypeAsString().
    
    Returns:
    
    The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.
    
    See Also:
    
    RootDeviceType
  - agentVersion
```
public String agentVersion()
```
    The default AWS OpsWorks Stacks agent version. You have the following options:
    - Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
    - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
    The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
    
    You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
    Returns:
    The default AWS OpsWorks Stacks agent version. You have the following options:
    
    Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
    
    Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
    
    The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
    
    You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
  - toBuilder
```
public CreateStackRequest.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<CreateStackRequest.Builder,CreateStackRequest>
    
    Specified by:
    
    toBuilder in class OpsWorksRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateStackRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateStackRequest.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 CreateStackRequest

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

name

region

vpcId

attributes

attributesAsStrings

serviceRoleArn

defaultInstanceProfileArn

defaultOs

hostnameTheme

defaultAvailabilityZone

defaultSubnetId

customJson

configurationManager

chefConfiguration

useCustomCookbooks

useOpsworksSecurityGroups

customCookbooksSource

defaultSshKeyName

defaultRootDeviceType

defaultRootDeviceTypeAsString

agentVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields