com.amazonaws.services.opsworks.model

Class CreateStackRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.CreateStackRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateStackRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateStackRequest()

Method Summary

Modifier and Type	Method and Description
CreateStackRequest	addAttributesEntry(String key, String value) Add a single Attributes entry
CreateStackRequest	clearAttributesEntries() Removes all the entries added into Attributes.
CreateStackRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAgentVersion() The default OpsWorks Stacks agent version.
Map<String,String>	getAttributes() One or more user-defined key-value pairs to be added to the stack attributes.
ChefConfiguration	getChefConfiguration() A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
StackConfigurationManager	getConfigurationManager() The configuration manager.
Source	getCustomCookbooksSource() Contains the information required to retrieve an app or cookbook from a repository.
String	getCustomJson() A string that contains user-defined, custom JSON.
String	getDefaultAvailabilityZone() The stack's default Availability Zone, which must be in the specified region.
String	getDefaultInstanceProfileArn() The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.
String	getDefaultOs() The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.
String	getDefaultRootDeviceType() The default root device type.
String	getDefaultSshKeyName() A default Amazon EC2 key pair name.
String	getDefaultSubnetId() The stack's default VPC subnet ID.
String	getHostnameTheme() The stack's host name theme, with spaces replaced by underscores.
String	getName() The stack name.
String	getRegion() The stack's Amazon Web Services Region, such as ap-south-1.
String	getServiceRoleArn() The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf.
Boolean	getUseCustomCookbooks() Whether the stack uses custom cookbooks.
Boolean	getUseOpsworksSecurityGroups() Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
String	getVpcId() The ID of the VPC that the stack is to be launched into.
int	hashCode()
Boolean	isUseCustomCookbooks() Whether the stack uses custom cookbooks.
Boolean	isUseOpsworksSecurityGroups() Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
void	setAgentVersion(String agentVersion) The default OpsWorks Stacks agent version.
void	setAttributes(Map<String,String> attributes) One or more user-defined key-value pairs to be added to the stack attributes.
void	setChefConfiguration(ChefConfiguration chefConfiguration) A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
void	setConfigurationManager(StackConfigurationManager configurationManager) The configuration manager.
void	setCustomCookbooksSource(Source customCookbooksSource) Contains the information required to retrieve an app or cookbook from a repository.
void	setCustomJson(String customJson) A string that contains user-defined, custom JSON.
void	setDefaultAvailabilityZone(String defaultAvailabilityZone) The stack's default Availability Zone, which must be in the specified region.
void	setDefaultInstanceProfileArn(String defaultInstanceProfileArn) The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.
void	setDefaultOs(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.
void	setDefaultRootDeviceType(RootDeviceType defaultRootDeviceType) The default root device type.
void	setDefaultRootDeviceType(String defaultRootDeviceType) The default root device type.
void	setDefaultSshKeyName(String defaultSshKeyName) A default Amazon EC2 key pair name.
void	setDefaultSubnetId(String defaultSubnetId) The stack's default VPC subnet ID.
void	setHostnameTheme(String hostnameTheme) The stack's host name theme, with spaces replaced by underscores.
void	setName(String name) The stack name.
void	setRegion(String region) The stack's Amazon Web Services Region, such as ap-south-1.
void	setServiceRoleArn(String serviceRoleArn) The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf.
void	setUseCustomCookbooks(Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.
void	setUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups) Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
void	setVpcId(String vpcId) The ID of the VPC that the stack is to be launched into.
String	toString() Returns a string representation of this object.
CreateStackRequest	withAgentVersion(String agentVersion) The default OpsWorks Stacks agent version.
CreateStackRequest	withAttributes(Map<String,String> attributes) One or more user-defined key-value pairs to be added to the stack attributes.
CreateStackRequest	withChefConfiguration(ChefConfiguration chefConfiguration) A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
CreateStackRequest	withConfigurationManager(StackConfigurationManager configurationManager) The configuration manager.
CreateStackRequest	withCustomCookbooksSource(Source customCookbooksSource) Contains the information required to retrieve an app or cookbook from a repository.
CreateStackRequest	withCustomJson(String customJson) A string that contains user-defined, custom JSON.
CreateStackRequest	withDefaultAvailabilityZone(String defaultAvailabilityZone) The stack's default Availability Zone, which must be in the specified region.
CreateStackRequest	withDefaultInstanceProfileArn(String defaultInstanceProfileArn) The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.
CreateStackRequest	withDefaultOs(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.
CreateStackRequest	withDefaultRootDeviceType(RootDeviceType defaultRootDeviceType) The default root device type.
CreateStackRequest	withDefaultRootDeviceType(String defaultRootDeviceType) The default root device type.
CreateStackRequest	withDefaultSshKeyName(String defaultSshKeyName) A default Amazon EC2 key pair name.
CreateStackRequest	withDefaultSubnetId(String defaultSubnetId) The stack's default VPC subnet ID.
CreateStackRequest	withHostnameTheme(String hostnameTheme) The stack's host name theme, with spaces replaced by underscores.
CreateStackRequest	withName(String name) The stack name.
CreateStackRequest	withRegion(String region) The stack's Amazon Web Services Region, such as ap-south-1.
CreateStackRequest	withServiceRoleArn(String serviceRoleArn) The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf.
CreateStackRequest	withUseCustomCookbooks(Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.
CreateStackRequest	withUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups) Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
CreateStackRequest	withVpcId(String vpcId) The ID of the VPC that the stack is to be launched into.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateStackRequest

public CreateStackRequest()

Method Detail

setName

public void setName(String name)

The stack name. Stack names can be a maximum of 64 characters.

Parameters:

name - The stack name. Stack names can be a maximum of 64 characters.

getName

public String getName()

The stack name. Stack names can be a maximum of 64 characters.

Returns:

The stack name. Stack names can be a maximum of 64 characters.

withName

public CreateStackRequest withName(String name)

The stack name. Stack names can be a maximum of 64 characters.

Parameters:

name - The stack name. Stack names can be a maximum of 64 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegion

public void setRegion(String region)

The stack's Amazon Web Services Region, such as ap-south-1. For more information about Amazon Web Services Regions, see Regions and Endpoints.

In the CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the 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 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 Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region.

Parameters:

region - The stack's Amazon Web Services Region, such as ap-south-1. For more information about Amazon Web Services Regions, see Regions and Endpoints.

In the CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the 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 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 Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region.

getRegion

public String getRegion()

The stack's Amazon Web Services Region, such as ap-south-1. For more information about Amazon Web Services Regions, see Regions and Endpoints.

In the CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the 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 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 Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region.

Returns:

The stack's Amazon Web Services Region, such as ap-south-1. For more information about Amazon Web Services Regions, see Regions and Endpoints.

In the CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the 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 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 Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region.

withRegion

public CreateStackRequest withRegion(String region)

The stack's Amazon Web Services Region, such as ap-south-1. For more information about Amazon Web Services Regions, see Regions and Endpoints.

In the CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the 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 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 Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region.

Parameters:

region - The stack's Amazon Web Services Region, such as ap-south-1. For more information about Amazon Web Services Regions, see Regions and Endpoints.

In the CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the 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 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 Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVpcId

public void setVpcId(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, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, 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 OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.

Parameters:

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, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, 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 OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.

getVpcId

public String getVpcId()

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, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, 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 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, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, 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 OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.

withVpcId

public CreateStackRequest withVpcId(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, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, 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 OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.

Parameters:

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, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, 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 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:

Returns a reference to this object so that method calls can be chained together.

getAttributes

public Map<String,String> getAttributes()

One or more user-defined key-value pairs to be added to the stack attributes.

Returns:

One or more user-defined key-value pairs to be added to the stack attributes.

setAttributes

public void setAttributes(Map<String,String> attributes)

One or more user-defined key-value pairs to be added to the stack attributes.

Parameters:

attributes - One or more user-defined key-value pairs to be added to the stack attributes.

withAttributes

public CreateStackRequest withAttributes(Map<String,String> attributes)

One or more user-defined key-value pairs to be added to the stack attributes.

Parameters:

attributes - One or more user-defined key-value pairs to be added to the stack attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAttributesEntry

public CreateStackRequest addAttributesEntry(String key,
                                             String value)

Add a single Attributes entry

See Also:

withAttributes(java.util.Map<java.lang.String, java.lang.String>)

clearAttributesEntries

public CreateStackRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

setServiceRoleArn

public void setServiceRoleArn(String serviceRoleArn)

The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services 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.

Parameters:

serviceRoleArn - The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services 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.

getServiceRoleArn

public String getServiceRoleArn()

The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services 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 IAM role, which allows OpsWorks Stacks to work with Amazon Web Services 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.

withServiceRoleArn

public CreateStackRequest withServiceRoleArn(String serviceRoleArn)

The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services 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.

Parameters:

serviceRoleArn - The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services 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:

Returns a reference to this object so that method calls can be chained together.

setDefaultInstanceProfileArn

public void setDefaultInstanceProfileArn(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.

Parameters:

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.

getDefaultInstanceProfileArn

public String getDefaultInstanceProfileArn()

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.

withDefaultInstanceProfileArn

public CreateStackRequest withDefaultInstanceProfileArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDefaultOs

public void setDefaultOs(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 2, Amazon Linux 2018.03, 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 18.04 LTS, 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. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.

Parameters:

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 2, Amazon Linux 2018.03, 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 18.04 LTS, 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. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.

getDefaultOs

public String getDefaultOs()

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 2, Amazon Linux 2018.03, 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 18.04 LTS, 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. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see 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 2, Amazon Linux 2018.03, 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 18.04 LTS, 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. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.

withDefaultOs

public CreateStackRequest withDefaultOs(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 2, Amazon Linux 2018.03, 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 18.04 LTS, 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. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.

Parameters:

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 2, Amazon Linux 2018.03, 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 18.04 LTS, 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. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHostnameTheme

public void setHostnameTheme(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_and_Titans

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

Parameters:

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_and_Titans

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

getHostnameTheme

public String getHostnameTheme()

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_and_Titans

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

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

withHostnameTheme

public CreateStackRequest withHostnameTheme(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_and_Titans

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

Parameters:

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_and_Titans

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

Returns a reference to this object so that method calls can be chained together.

setDefaultAvailabilityZone

public void setDefaultAvailabilityZone(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.

Parameters:

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.

getDefaultAvailabilityZone

public String getDefaultAvailabilityZone()

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.

withDefaultAvailabilityZone

public CreateStackRequest withDefaultAvailabilityZone(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDefaultSubnetId

public void setDefaultSubnetId(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.

Parameters:

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.

getDefaultSubnetId

public String getDefaultSubnetId()

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.

withDefaultSubnetId

public CreateStackRequest withDefaultSubnetId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setCustomJson

public void setCustomJson(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.

Parameters:

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.

getCustomJson

public String getCustomJson()

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.

withCustomJson

public CreateStackRequest withCustomJson(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setConfigurationManager

public void setConfigurationManager(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.

Parameters:

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.

getConfigurationManager

public StackConfigurationManager getConfigurationManager()

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.

withConfigurationManager

public CreateStackRequest withConfigurationManager(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setChefConfiguration

public void setChefConfiguration(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.

Parameters:

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.

getChefConfiguration

public ChefConfiguration getChefConfiguration()

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.

withChefConfiguration

public CreateStackRequest withChefConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setUseCustomCookbooks

public void setUseCustomCookbooks(Boolean useCustomCookbooks)

Whether the stack uses custom cookbooks.

Parameters:

useCustomCookbooks - Whether the stack uses custom cookbooks.

getUseCustomCookbooks

public Boolean getUseCustomCookbooks()

Whether the stack uses custom cookbooks.

Returns:

Whether the stack uses custom cookbooks.

withUseCustomCookbooks

public CreateStackRequest withUseCustomCookbooks(Boolean useCustomCookbooks)

Whether the stack uses custom cookbooks.

Parameters:

useCustomCookbooks - Whether the stack uses custom cookbooks.

Returns:

Returns a reference to this object so that method calls can be chained together.

isUseCustomCookbooks

public Boolean isUseCustomCookbooks()

Whether the stack uses custom cookbooks.

Returns:

Whether the stack uses custom cookbooks.

setUseOpsworksSecurityGroups

public void setUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

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

Parameters:

useOpsworksSecurityGroups - Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

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

getUseOpsworksSecurityGroups

public Boolean getUseOpsworksSecurityGroups()

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

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 - 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 - 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 OpsWorks Stacks built-in security groups with the stack's layers.

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

withUseOpsworksSecurityGroups

public CreateStackRequest withUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

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

Parameters:

useOpsworksSecurityGroups - Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

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 - 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 - 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:

Returns a reference to this object so that method calls can be chained together.

isUseOpsworksSecurityGroups

public Boolean isUseOpsworksSecurityGroups()

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

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 - 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 - 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 OpsWorks Stacks built-in security groups with the stack's layers.

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

setCustomCookbooksSource

public void setCustomCookbooksSource(Source customCookbooksSource)

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

Parameters:

customCookbooksSource - Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

getCustomCookbooksSource

public Source getCustomCookbooksSource()

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

Returns:

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

withCustomCookbooksSource

public CreateStackRequest withCustomCookbooksSource(Source customCookbooksSource)

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

Parameters:

customCookbooksSource - Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDefaultSshKeyName

public void setDefaultSshKeyName(String defaultSshKeyName)

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, 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.

Parameters:

defaultSshKeyName - A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, 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.

getDefaultSshKeyName

public String getDefaultSshKeyName()

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, 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, 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.

withDefaultSshKeyName

public CreateStackRequest withDefaultSshKeyName(String defaultSshKeyName)

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, 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.

Parameters:

defaultSshKeyName - A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, 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:

Returns a reference to this object so that method calls can be chained together.

setDefaultRootDeviceType

public void setDefaultRootDeviceType(String 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.

Parameters:

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.

See Also:

RootDeviceType

getDefaultRootDeviceType

public String getDefaultRootDeviceType()

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.

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

withDefaultRootDeviceType

public CreateStackRequest withDefaultRootDeviceType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RootDeviceType

setDefaultRootDeviceType

public void setDefaultRootDeviceType(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.

Parameters:

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.

See Also:

RootDeviceType

withDefaultRootDeviceType

public CreateStackRequest withDefaultRootDeviceType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RootDeviceType

setAgentVersion

public void setAgentVersion(String agentVersion)

The default OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. 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. OpsWorks Stacks 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.

Parameters:

agentVersion - The default OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. 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. OpsWorks Stacks 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.

getAgentVersion

public String getAgentVersion()

The default OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. 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. OpsWorks Stacks 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 OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. 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. OpsWorks Stacks 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.

withAgentVersion

public CreateStackRequest withAgentVersion(String agentVersion)

The default OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. 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. OpsWorks Stacks 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.

Parameters:

agentVersion - The default OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. 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. OpsWorks Stacks 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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateStackRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()