@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateServerRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateServerRequest() |
Modifier and Type | Method and Description |
---|---|
CreateServerRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getAssociatePublicIpAddress()
Associate a public IP address with a server that you are launching.
|
String |
getBackupId()
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
|
Integer |
getBackupRetentionCount()
The number of automated backups that you want to keep.
|
String |
getCustomCertificate()
A PEM-formatted HTTPS certificate.
|
String |
getCustomDomain()
An optional public endpoint of a server, such as
https://aws.my-company.com . |
String |
getCustomPrivateKey()
A private key in PEM format for connecting to the server by using HTTPS.
|
Boolean |
getDisableAutomatedBackup()
Enable or disable scheduled backups.
|
String |
getEngine()
The configuration management engine to use.
|
List<EngineAttribute> |
getEngineAttributes()
Optional engine attributes on a specified server.
|
String |
getEngineModel()
The engine model of the server.
|
String |
getEngineVersion()
The major release version of the engine that you want to use.
|
String |
getInstanceProfileArn()
The ARN of the instance profile that your Amazon EC2 instances use.
|
String |
getInstanceType()
The Amazon EC2 instance type to use.
|
String |
getKeyPair()
The Amazon EC2 key pair to set for the instance.
|
String |
getPreferredBackupWindow()
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server
if automated backups are enabled.
|
String |
getPreferredMaintenanceWindow()
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
|
List<String> |
getSecurityGroupIds()
A list of security group IDs to attach to the Amazon EC2 instance.
|
String |
getServerName()
The name of the server.
|
String |
getServiceRoleArn()
The service role that the AWS OpsWorks CM service backend uses to work with your account.
|
List<String> |
getSubnetIds()
The IDs of subnets in which to launch the server EC2 instance.
|
List<Tag> |
getTags()
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for
Puppet Enterprise server.
|
int |
hashCode() |
Boolean |
isAssociatePublicIpAddress()
Associate a public IP address with a server that you are launching.
|
Boolean |
isDisableAutomatedBackup()
Enable or disable scheduled backups.
|
void |
setAssociatePublicIpAddress(Boolean associatePublicIpAddress)
Associate a public IP address with a server that you are launching.
|
void |
setBackupId(String backupId)
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
|
void |
setBackupRetentionCount(Integer backupRetentionCount)
The number of automated backups that you want to keep.
|
void |
setCustomCertificate(String customCertificate)
A PEM-formatted HTTPS certificate.
|
void |
setCustomDomain(String customDomain)
An optional public endpoint of a server, such as
https://aws.my-company.com . |
void |
setCustomPrivateKey(String customPrivateKey)
A private key in PEM format for connecting to the server by using HTTPS.
|
void |
setDisableAutomatedBackup(Boolean disableAutomatedBackup)
Enable or disable scheduled backups.
|
void |
setEngine(String engine)
The configuration management engine to use.
|
void |
setEngineAttributes(Collection<EngineAttribute> engineAttributes)
Optional engine attributes on a specified server.
|
void |
setEngineModel(String engineModel)
The engine model of the server.
|
void |
setEngineVersion(String engineVersion)
The major release version of the engine that you want to use.
|
void |
setInstanceProfileArn(String instanceProfileArn)
The ARN of the instance profile that your Amazon EC2 instances use.
|
void |
setInstanceType(String instanceType)
The Amazon EC2 instance type to use.
|
void |
setKeyPair(String keyPair)
The Amazon EC2 key pair to set for the instance.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server
if automated backups are enabled.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
A list of security group IDs to attach to the Amazon EC2 instance.
|
void |
setServerName(String serverName)
The name of the server.
|
void |
setServiceRoleArn(String serviceRoleArn)
The service role that the AWS OpsWorks CM service backend uses to work with your account.
|
void |
setSubnetIds(Collection<String> subnetIds)
The IDs of subnets in which to launch the server EC2 instance.
|
void |
setTags(Collection<Tag> tags)
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for
Puppet Enterprise server.
|
String |
toString()
Returns a string representation of this object.
|
CreateServerRequest |
withAssociatePublicIpAddress(Boolean associatePublicIpAddress)
Associate a public IP address with a server that you are launching.
|
CreateServerRequest |
withBackupId(String backupId)
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
|
CreateServerRequest |
withBackupRetentionCount(Integer backupRetentionCount)
The number of automated backups that you want to keep.
|
CreateServerRequest |
withCustomCertificate(String customCertificate)
A PEM-formatted HTTPS certificate.
|
CreateServerRequest |
withCustomDomain(String customDomain)
An optional public endpoint of a server, such as
https://aws.my-company.com . |
CreateServerRequest |
withCustomPrivateKey(String customPrivateKey)
A private key in PEM format for connecting to the server by using HTTPS.
|
CreateServerRequest |
withDisableAutomatedBackup(Boolean disableAutomatedBackup)
Enable or disable scheduled backups.
|
CreateServerRequest |
withEngine(String engine)
The configuration management engine to use.
|
CreateServerRequest |
withEngineAttributes(Collection<EngineAttribute> engineAttributes)
Optional engine attributes on a specified server.
|
CreateServerRequest |
withEngineAttributes(EngineAttribute... engineAttributes)
Optional engine attributes on a specified server.
|
CreateServerRequest |
withEngineModel(String engineModel)
The engine model of the server.
|
CreateServerRequest |
withEngineVersion(String engineVersion)
The major release version of the engine that you want to use.
|
CreateServerRequest |
withInstanceProfileArn(String instanceProfileArn)
The ARN of the instance profile that your Amazon EC2 instances use.
|
CreateServerRequest |
withInstanceType(String instanceType)
The Amazon EC2 instance type to use.
|
CreateServerRequest |
withKeyPair(String keyPair)
The Amazon EC2 key pair to set for the instance.
|
CreateServerRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server
if automated backups are enabled.
|
CreateServerRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
|
CreateServerRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
A list of security group IDs to attach to the Amazon EC2 instance.
|
CreateServerRequest |
withSecurityGroupIds(String... securityGroupIds)
A list of security group IDs to attach to the Amazon EC2 instance.
|
CreateServerRequest |
withServerName(String serverName)
The name of the server.
|
CreateServerRequest |
withServiceRoleArn(String serviceRoleArn)
The service role that the AWS OpsWorks CM service backend uses to work with your account.
|
CreateServerRequest |
withSubnetIds(Collection<String> subnetIds)
The IDs of subnets in which to launch the server EC2 instance.
|
CreateServerRequest |
withSubnetIds(String... subnetIds)
The IDs of subnets in which to launch the server EC2 instance.
|
CreateServerRequest |
withTags(Collection<Tag> tags)
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for
Puppet Enterprise server.
|
CreateServerRequest |
withTags(Tag... tags)
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for
Puppet Enterprise server.
|
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
public void setAssociatePublicIpAddress(Boolean associatePublicIpAddress)
Associate a public IP address with a server that you are launching. Valid values are true
or
false
. The default value is true
.
associatePublicIpAddress
- Associate a public IP address with a server that you are launching. Valid values are true
or
false
. The default value is true
.public Boolean getAssociatePublicIpAddress()
Associate a public IP address with a server that you are launching. Valid values are true
or
false
. The default value is true
.
true
or
false
. The default value is true
.public CreateServerRequest withAssociatePublicIpAddress(Boolean associatePublicIpAddress)
Associate a public IP address with a server that you are launching. Valid values are true
or
false
. The default value is true
.
associatePublicIpAddress
- Associate a public IP address with a server that you are launching. Valid values are true
or
false
. The default value is true
.public Boolean isAssociatePublicIpAddress()
Associate a public IP address with a server that you are launching. Valid values are true
or
false
. The default value is true
.
true
or
false
. The default value is true
.public void setCustomDomain(String customDomain)
An optional public endpoint of a server, such as https://aws.my-company.com
. To access the server,
create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is
generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the
server by using the generated Endpoint
value if the server is using a custom domain. If you specify
a custom domain, you must also specify values for CustomCertificate
and
CustomPrivateKey
.
customDomain
- An optional public endpoint of a server, such as https://aws.my-company.com
. To access the
server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the
endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute).
You cannot access the server by using the generated Endpoint
value if the server is using a
custom domain. If you specify a custom domain, you must also specify values for
CustomCertificate
and CustomPrivateKey
.public String getCustomDomain()
An optional public endpoint of a server, such as https://aws.my-company.com
. To access the server,
create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is
generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the
server by using the generated Endpoint
value if the server is using a custom domain. If you specify
a custom domain, you must also specify values for CustomCertificate
and
CustomPrivateKey
.
https://aws.my-company.com
. To access the
server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the
endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute).
You cannot access the server by using the generated Endpoint
value if the server is using a
custom domain. If you specify a custom domain, you must also specify values for
CustomCertificate
and CustomPrivateKey
.public CreateServerRequest withCustomDomain(String customDomain)
An optional public endpoint of a server, such as https://aws.my-company.com
. To access the server,
create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is
generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the
server by using the generated Endpoint
value if the server is using a custom domain. If you specify
a custom domain, you must also specify values for CustomCertificate
and
CustomPrivateKey
.
customDomain
- An optional public endpoint of a server, such as https://aws.my-company.com
. To access the
server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the
endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute).
You cannot access the server by using the generated Endpoint
value if the server is using a
custom domain. If you specify a custom domain, you must also specify values for
CustomCertificate
and CustomPrivateKey
.public void setCustomCertificate(String customCertificate)
A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain.
If you specify a custom certificate, you must also specify values for CustomDomain
and
CustomPrivateKey
. The following are requirements for the CustomCertificate
value:
You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity period
begins (the certificate's NotBefore
date), or after it expires (the certificate's
NotAfter
date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of
CustomDomain
.
The certificate must match the value of CustomPrivateKey
.
customCertificate
- A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate
chain. If you specify a custom certificate, you must also specify values for CustomDomain
and
CustomPrivateKey
. The following are requirements for the CustomCertificate
value:
You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity
period begins (the certificate's NotBefore
date), or after it expires (the certificate's
NotAfter
date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of
CustomDomain
.
The certificate must match the value of CustomPrivateKey
.
public String getCustomCertificate()
A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain.
If you specify a custom certificate, you must also specify values for CustomDomain
and
CustomPrivateKey
. The following are requirements for the CustomCertificate
value:
You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity period
begins (the certificate's NotBefore
date), or after it expires (the certificate's
NotAfter
date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of
CustomDomain
.
The certificate must match the value of CustomPrivateKey
.
CustomDomain
and CustomPrivateKey
. The following are requirements for the
CustomCertificate
value:
You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity
period begins (the certificate's NotBefore
date), or after it expires (the certificate's
NotAfter
date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of
CustomDomain
.
The certificate must match the value of CustomPrivateKey
.
public CreateServerRequest withCustomCertificate(String customCertificate)
A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain.
If you specify a custom certificate, you must also specify values for CustomDomain
and
CustomPrivateKey
. The following are requirements for the CustomCertificate
value:
You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity period
begins (the certificate's NotBefore
date), or after it expires (the certificate's
NotAfter
date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of
CustomDomain
.
The certificate must match the value of CustomPrivateKey
.
customCertificate
- A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate
chain. If you specify a custom certificate, you must also specify values for CustomDomain
and
CustomPrivateKey
. The following are requirements for the CustomCertificate
value:
You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity
period begins (the certificate's NotBefore
date), or after it expires (the certificate's
NotAfter
date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of
CustomDomain
.
The certificate must match the value of CustomPrivateKey
.
public void setCustomPrivateKey(String customPrivateKey)
A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted;
it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify
values for CustomDomain
and CustomCertificate
.
customPrivateKey
- A private key in PEM format for connecting to the server by using HTTPS. The private key must not be
encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you
must also specify values for CustomDomain
and CustomCertificate
.public String getCustomPrivateKey()
A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted;
it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify
values for CustomDomain
and CustomCertificate
.
CustomDomain
and CustomCertificate
.public CreateServerRequest withCustomPrivateKey(String customPrivateKey)
A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted;
it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify
values for CustomDomain
and CustomCertificate
.
customPrivateKey
- A private key in PEM format for connecting to the server by using HTTPS. The private key must not be
encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you
must also specify values for CustomDomain
and CustomCertificate
.public void setDisableAutomatedBackup(Boolean disableAutomatedBackup)
Enable or disable scheduled backups. Valid values are true
or false
. The default value
is true
.
disableAutomatedBackup
- Enable or disable scheduled backups. Valid values are true
or false
. The default
value is true
.public Boolean getDisableAutomatedBackup()
Enable or disable scheduled backups. Valid values are true
or false
. The default value
is true
.
true
or false
. The
default value is true
.public CreateServerRequest withDisableAutomatedBackup(Boolean disableAutomatedBackup)
Enable or disable scheduled backups. Valid values are true
or false
. The default value
is true
.
disableAutomatedBackup
- Enable or disable scheduled backups. Valid values are true
or false
. The default
value is true
.public Boolean isDisableAutomatedBackup()
Enable or disable scheduled backups. Valid values are true
or false
. The default value
is true
.
true
or false
. The
default value is true
.public void setEngine(String engine)
The configuration management engine to use. Valid values include ChefAutomate
and
Puppet
.
engine
- The configuration management engine to use. Valid values include ChefAutomate
and
Puppet
.public String getEngine()
The configuration management engine to use. Valid values include ChefAutomate
and
Puppet
.
ChefAutomate
and
Puppet
.public CreateServerRequest withEngine(String engine)
The configuration management engine to use. Valid values include ChefAutomate
and
Puppet
.
engine
- The configuration management engine to use. Valid values include ChefAutomate
and
Puppet
.public void setEngineModel(String engineModel)
The engine model of the server. Valid values in this release include Monolithic
for Puppet and
Single
for Chef.
engineModel
- The engine model of the server. Valid values in this release include Monolithic
for Puppet
and Single
for Chef.public String getEngineModel()
The engine model of the server. Valid values in this release include Monolithic
for Puppet and
Single
for Chef.
Monolithic
for Puppet
and Single
for Chef.public CreateServerRequest withEngineModel(String engineModel)
The engine model of the server. Valid values in this release include Monolithic
for Puppet and
Single
for Chef.
engineModel
- The engine model of the server. Valid values in this release include Monolithic
for Puppet
and Single
for Chef.public void setEngineVersion(String engineVersion)
The major release version of the engine that you want to use. For a Chef server, the valid value for
EngineVersion is currently 2
. For a Puppet server, valid values are 2019
or
2017
.
engineVersion
- The major release version of the engine that you want to use. For a Chef server, the valid value for
EngineVersion is currently 2
. For a Puppet server, valid values are 2019
or
2017
.public String getEngineVersion()
The major release version of the engine that you want to use. For a Chef server, the valid value for
EngineVersion is currently 2
. For a Puppet server, valid values are 2019
or
2017
.
2
. For a Puppet server, valid values are 2019
or
2017
.public CreateServerRequest withEngineVersion(String engineVersion)
The major release version of the engine that you want to use. For a Chef server, the valid value for
EngineVersion is currently 2
. For a Puppet server, valid values are 2019
or
2017
.
engineVersion
- The major release version of the engine that you want to use. For a Chef server, the valid value for
EngineVersion is currently 2
. For a Puppet server, valid values are 2019
or
2017
.public List<EngineAttribute> getEngineAttributes()
Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY
: A base64-encoded RSA public key. The corresponding private key is
required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and
returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate
web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can
contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower
case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD
is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD
: To work with the Puppet Enterprise console, a password must use ASCII
characters.
PUPPET_R10K_REMOTE
: The r10k remote is the URL of your control repository (for example,
ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY
: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to
specify a PEM-encoded private SSH key.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY
: A base64-encoded RSA public key. The corresponding private key is
required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and
returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate
web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The
password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must
contain at least one lower case letter, one upper case letter, one number, and one special character.
When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD
: To work with the Puppet Enterprise console, a password must use ASCII
characters.
PUPPET_R10K_REMOTE
: The r10k remote is the URL of your control repository (for example,
ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY
: If you are using a private Git repository, add
PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
public void setEngineAttributes(Collection<EngineAttribute> engineAttributes)
Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY
: A base64-encoded RSA public key. The corresponding private key is
required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and
returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate
web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can
contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower
case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD
is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD
: To work with the Puppet Enterprise console, a password must use ASCII
characters.
PUPPET_R10K_REMOTE
: The r10k remote is the URL of your control repository (for example,
ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY
: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to
specify a PEM-encoded private SSH key.
engineAttributes
- Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY
: A base64-encoded RSA public key. The corresponding private key is
required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and
returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate
web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The
password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain
at least one lower case letter, one upper case letter, one number, and one special character. When no
CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD
: To work with the Puppet Enterprise console, a password must use ASCII
characters.
PUPPET_R10K_REMOTE
: The r10k remote is the URL of your control repository (for example,
ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY
: If you are using a private Git repository, add
PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
public CreateServerRequest withEngineAttributes(EngineAttribute... engineAttributes)
Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY
: A base64-encoded RSA public key. The corresponding private key is
required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and
returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate
web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can
contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower
case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD
is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD
: To work with the Puppet Enterprise console, a password must use ASCII
characters.
PUPPET_R10K_REMOTE
: The r10k remote is the URL of your control repository (for example,
ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY
: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to
specify a PEM-encoded private SSH key.
NOTE: This method appends the values to the existing list (if any). Use
setEngineAttributes(java.util.Collection)
or withEngineAttributes(java.util.Collection)
if you
want to override the existing values.
engineAttributes
- Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY
: A base64-encoded RSA public key. The corresponding private key is
required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and
returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate
web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The
password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain
at least one lower case letter, one upper case letter, one number, and one special character. When no
CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD
: To work with the Puppet Enterprise console, a password must use ASCII
characters.
PUPPET_R10K_REMOTE
: The r10k remote is the URL of your control repository (for example,
ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY
: If you are using a private Git repository, add
PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
public CreateServerRequest withEngineAttributes(Collection<EngineAttribute> engineAttributes)
Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY
: A base64-encoded RSA public key. The corresponding private key is
required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and
returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate
web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can
contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower
case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD
is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD
: To work with the Puppet Enterprise console, a password must use ASCII
characters.
PUPPET_R10K_REMOTE
: The r10k remote is the URL of your control repository (for example,
ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY
: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to
specify a PEM-encoded private SSH key.
engineAttributes
- Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY
: A base64-encoded RSA public key. The corresponding private key is
required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and
returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate
web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The
password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain
at least one lower case letter, one upper case letter, one number, and one special character. When no
CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD
: To work with the Puppet Enterprise console, a password must use ASCII
characters.
PUPPET_R10K_REMOTE
: The r10k remote is the URL of your control repository (for example,
ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY
: If you are using a private Git repository, add
PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
public void setBackupRetentionCount(Integer backupRetentionCount)
The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes
the oldest backups if this number is exceeded. The default value is 1
.
backupRetentionCount
- The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM
deletes the oldest backups if this number is exceeded. The default value is 1
.public Integer getBackupRetentionCount()
The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes
the oldest backups if this number is exceeded. The default value is 1
.
1
.public CreateServerRequest withBackupRetentionCount(Integer backupRetentionCount)
The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes
the oldest backups if this number is exceeded. The default value is 1
.
backupRetentionCount
- The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM
deletes the oldest backups if this number is exceeded. The default value is 1
.public void setServerName(String serverName)
The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
serverName
- The name of the server. The server name must be unique within your AWS account, within each region. Server
names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40
characters.public String getServerName()
The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
public CreateServerRequest withServerName(String serverName)
The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
serverName
- The name of the server. The server name must be unique within your AWS account, within each region. Server
names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40
characters.public void setInstanceProfileArn(String instanceProfileArn)
The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.
instanceProfileArn
- The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console
typically creates the instance profile for you, if you are using API commands instead, run the
service-role-creation.yaml AWS CloudFormation template, located at
https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This
template creates a CloudFormation stack that includes the instance profile you need.public String getInstanceProfileArn()
The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.
public CreateServerRequest withInstanceProfileArn(String instanceProfileArn)
The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.
instanceProfileArn
- The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console
typically creates the instance profile for you, if you are using API commands instead, run the
service-role-creation.yaml AWS CloudFormation template, located at
https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This
template creates a CloudFormation stack that includes the instance profile you need.public void setInstanceType(String instanceType)
The Amazon EC2 instance type to use. For example, m5.large
.
instanceType
- The Amazon EC2 instance type to use. For example, m5.large
.public String getInstanceType()
The Amazon EC2 instance type to use. For example, m5.large
.
m5.large
.public CreateServerRequest withInstanceType(String instanceType)
The Amazon EC2 instance type to use. For example, m5.large
.
instanceType
- The Amazon EC2 instance type to use. For example, m5.large
.public void setKeyPair(String keyPair)
The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.
keyPair
- The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify
this parameter to connect to your instances by using SSH.public String getKeyPair()
The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.
public CreateServerRequest withKeyPair(String keyPair)
The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.
keyPair
- The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify
this parameter to connect to your instances by using SSH.public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
Valid values must be specified in the following format: DDD:HH:MM
. MM
must be specified
as 00
. The specified time is in coordinated universal time (UTC). The default value is a random
one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition
for more information.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
preferredMaintenanceWindow
- The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the
instance. Valid values must be specified in the following format: DDD:HH:MM
. MM
must be specified as 00
. The specified time is in coordinated universal time (UTC). The
default value is a random one-hour period on Tuesday, Wednesday, or Friday. See
TimeWindowDefinition
for more information.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00
a.m.)
public String getPreferredMaintenanceWindow()
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
Valid values must be specified in the following format: DDD:HH:MM
. MM
must be specified
as 00
. The specified time is in coordinated universal time (UTC). The default value is a random
one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition
for more information.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
DDD:HH:MM
. MM
must be specified as 00
. The specified time is in coordinated universal time (UTC). The
default value is a random one-hour period on Tuesday, Wednesday, or Friday. See
TimeWindowDefinition
for more information.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00
a.m.)
public CreateServerRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
Valid values must be specified in the following format: DDD:HH:MM
. MM
must be specified
as 00
. The specified time is in coordinated universal time (UTC). The default value is a random
one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition
for more information.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
preferredMaintenanceWindow
- The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the
instance. Valid values must be specified in the following format: DDD:HH:MM
. MM
must be specified as 00
. The specified time is in coordinated universal time (UTC). The
default value is a random one-hour period on Tuesday, Wednesday, or Friday. See
TimeWindowDefinition
for more information.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00
a.m.)
public void setPreferredBackupWindow(String preferredBackupWindow)
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:
HH:MM
for daily backups
DDD:HH:MM
for weekly backups
MM
must be specified as 00
. The specified time is in coordinated universal time (UTC).
The default value is a random, daily start time.
Example: 08:00
, which represents a daily start time of 08:00 UTC.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
preferredBackupWindow
- The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your
server if automated backups are enabled. Valid values must be specified in one of the following formats:
HH:MM
for daily backups
DDD:HH:MM
for weekly backups
MM
must be specified as 00
. The specified time is in coordinated universal time
(UTC). The default value is a random, daily start time.
Example: 08:00
, which represents a daily start time of 08:00 UTC.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00
a.m.)
public String getPreferredBackupWindow()
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:
HH:MM
for daily backups
DDD:HH:MM
for weekly backups
MM
must be specified as 00
. The specified time is in coordinated universal time (UTC).
The default value is a random, daily start time.
Example: 08:00
, which represents a daily start time of 08:00 UTC.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
HH:MM
for daily backups
DDD:HH:MM
for weekly backups
MM
must be specified as 00
. The specified time is in coordinated universal time
(UTC). The default value is a random, daily start time.
Example: 08:00
, which represents a daily start time of 08:00 UTC.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00
a.m.)
public CreateServerRequest withPreferredBackupWindow(String preferredBackupWindow)
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:
HH:MM
for daily backups
DDD:HH:MM
for weekly backups
MM
must be specified as 00
. The specified time is in coordinated universal time (UTC).
The default value is a random, daily start time.
Example: 08:00
, which represents a daily start time of 08:00 UTC.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
preferredBackupWindow
- The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your
server if automated backups are enabled. Valid values must be specified in one of the following formats:
HH:MM
for daily backups
DDD:HH:MM
for weekly backups
MM
must be specified as 00
. The specified time is in coordinated universal time
(UTC). The default value is a random, daily start time.
Example: 08:00
, which represents a daily start time of 08:00 UTC.
Example: Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00
a.m.)
public List<String> getSecurityGroupIds()
A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified
security groups must be within the VPC that is specified by SubnetIds
.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
SubnetIds
.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
public void setSecurityGroupIds(Collection<String> securityGroupIds)
A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified
security groups must be within the VPC that is specified by SubnetIds
.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
securityGroupIds
- A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the
specified security groups must be within the VPC that is specified by SubnetIds
.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
public CreateServerRequest withSecurityGroupIds(String... securityGroupIds)
A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified
security groups must be within the VPC that is specified by SubnetIds
.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroupIds(java.util.Collection)
or withSecurityGroupIds(java.util.Collection)
if you
want to override the existing values.
securityGroupIds
- A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the
specified security groups must be within the VPC that is specified by SubnetIds
.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
public CreateServerRequest withSecurityGroupIds(Collection<String> securityGroupIds)
A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified
security groups must be within the VPC that is specified by SubnetIds
.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
securityGroupIds
- A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the
specified security groups must be within the VPC that is specified by SubnetIds
.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
public void setServiceRoleArn(String serviceRoleArn)
The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.
serviceRoleArn
- The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS
OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or
API commands, run the service-role-creation.yaml AWS CloudFormation template, located at
https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This
template creates a CloudFormation stack that includes the service role and instance profile that you need.public String getServiceRoleArn()
The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.
public CreateServerRequest withServiceRoleArn(String serviceRoleArn)
The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.
serviceRoleArn
- The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS
OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or
API commands, run the service-role-creation.yaml AWS CloudFormation template, located at
https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This
template creates a CloudFormation stack that includes the service role and instance profile that you need.public List<String> getSubnetIds()
The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
public void setSubnetIds(Collection<String> subnetIds)
The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
subnetIds
- The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
public CreateServerRequest withSubnetIds(String... subnetIds)
The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
NOTE: This method appends the values to the existing list (if any). Use
setSubnetIds(java.util.Collection)
or withSubnetIds(java.util.Collection)
if you want to
override the existing values.
subnetIds
- The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
public CreateServerRequest withSubnetIds(Collection<String> subnetIds)
The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
subnetIds
- The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
public List<Tag> getTags()
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : / @
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : / @
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators,
or the following special characters: + - = . _ : / @
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or
the following special characters: + - = . _ : / @
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
public void setTags(Collection<Tag> tags)
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : / @
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : / @
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
tags
- A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks
for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators,
or the following special characters: + - = . _ : / @
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or
the following special characters: + - = . _ : / @
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
public CreateServerRequest withTags(Tag... tags)
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : / @
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : / @
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks
for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators,
or the following special characters: + - = . _ : / @
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or
the following special characters: + - = . _ : / @
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
public CreateServerRequest withTags(Collection<Tag> tags)
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : / @
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
following special characters: + - = . _ : / @
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
tags
- A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks
for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators,
or the following special characters: + - = . _ : / @
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or
the following special characters: + - = . _ : / @
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
public void setBackupId(String backupId)
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
backupId
- If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.public String getBackupId()
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
public CreateServerRequest withBackupId(String backupId)
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
backupId
- If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.public String toString()
toString
in class Object
Object.toString()
public CreateServerRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()