Interface CreateServerRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>,OpsWorksCmRequest.Builder,SdkBuilder<CreateServerRequest.Builder,CreateServerRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateServerRequest
public static interface CreateServerRequest.Builder extends OpsWorksCmRequest.Builder, SdkPojo, CopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateServerRequest.BuilderassociatePublicIpAddress(Boolean associatePublicIpAddress)Associate a public IP address with a server that you are launching.CreateServerRequest.BuilderbackupId(String backupId)If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.CreateServerRequest.BuilderbackupRetentionCount(Integer backupRetentionCount)The number of automated backups that you want to keep.CreateServerRequest.BuildercustomCertificate(String customCertificate)A PEM-formatted HTTPS certificate.CreateServerRequest.BuildercustomDomain(String customDomain)An optional public endpoint of a server, such ashttps://aws.my-company.com.CreateServerRequest.BuildercustomPrivateKey(String customPrivateKey)A private key in PEM format for connecting to the server by using HTTPS.CreateServerRequest.BuilderdisableAutomatedBackup(Boolean disableAutomatedBackup)Enable or disable scheduled backups.CreateServerRequest.Builderengine(String engine)The configuration management engine to use.CreateServerRequest.BuilderengineAttributes(Collection<EngineAttribute> engineAttributes)Optional engine attributes on a specified server.CreateServerRequest.BuilderengineAttributes(Consumer<EngineAttribute.Builder>... engineAttributes)Optional engine attributes on a specified server.CreateServerRequest.BuilderengineAttributes(EngineAttribute... engineAttributes)Optional engine attributes on a specified server.CreateServerRequest.BuilderengineModel(String engineModel)The engine model of the server.CreateServerRequest.BuilderengineVersion(String engineVersion)The major release version of the engine that you want to use.CreateServerRequest.BuilderinstanceProfileArn(String instanceProfileArn)The ARN of the instance profile that your Amazon EC2 instances use.CreateServerRequest.BuilderinstanceType(String instanceType)The Amazon EC2 instance type to use.CreateServerRequest.BuilderkeyPair(String keyPair)The Amazon EC2 key pair to set for the instance.CreateServerRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateServerRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateServerRequest.BuilderpreferredBackupWindow(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.BuilderpreferredMaintenanceWindow(String preferredMaintenanceWindow)The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.CreateServerRequest.BuildersecurityGroupIds(String... securityGroupIds)A list of security group IDs to attach to the Amazon EC2 instance.CreateServerRequest.BuildersecurityGroupIds(Collection<String> securityGroupIds)A list of security group IDs to attach to the Amazon EC2 instance.CreateServerRequest.BuilderserverName(String serverName)The name of the server.CreateServerRequest.BuilderserviceRoleArn(String serviceRoleArn)The service role that the AWS OpsWorks CM service backend uses to work with your account.CreateServerRequest.BuildersubnetIds(String... subnetIds)The IDs of subnets in which to launch the server EC2 instance.CreateServerRequest.BuildersubnetIds(Collection<String> subnetIds)The IDs of subnets in which to launch the server EC2 instance.CreateServerRequest.Buildertags(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.Buildertags(Consumer<Tag.Builder>... 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.Buildertags(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.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.opsworkscm.model.OpsWorksCmRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
associatePublicIpAddress
CreateServerRequest.Builder associatePublicIpAddress(Boolean associatePublicIpAddress)
Associate a public IP address with a server that you are launching. Valid values are
trueorfalse. The default value istrue.- Parameters:
associatePublicIpAddress- Associate a public IP address with a server that you are launching. Valid values aretrueorfalse. The default value istrue.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customDomain
CreateServerRequest.Builder customDomain(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 generatedEndpointvalue if the server is using a custom domain. If you specify a custom domain, you must also specify values forCustomCertificateandCustomPrivateKey.- Parameters:
customDomain- An optional public endpoint of a server, such ashttps://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 generatedEndpointvalue if the server is using a custom domain. If you specify a custom domain, you must also specify values forCustomCertificateandCustomPrivateKey.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customCertificate
CreateServerRequest.Builder customCertificate(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
CustomDomainandCustomPrivateKey. The following are requirements for theCustomCertificatevalue:-
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
NotBeforedate), or after it expires (the certificate'sNotAfterdate). -
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.
- Parameters:
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 forCustomDomainandCustomPrivateKey. The following are requirements for theCustomCertificatevalue:-
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
NotBeforedate), or after it expires (the certificate'sNotAfterdate). -
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
customPrivateKey
CreateServerRequest.Builder customPrivateKey(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
CustomDomainandCustomCertificate.- Parameters:
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 forCustomDomainandCustomCertificate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
disableAutomatedBackup
CreateServerRequest.Builder disableAutomatedBackup(Boolean disableAutomatedBackup)
Enable or disable scheduled backups. Valid values are
trueorfalse. The default value istrue.- Parameters:
disableAutomatedBackup- Enable or disable scheduled backups. Valid values aretrueorfalse. The default value istrue.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engine
CreateServerRequest.Builder engine(String engine)
The configuration management engine to use. Valid values include
ChefAutomateandPuppet.- Parameters:
engine- The configuration management engine to use. Valid values includeChefAutomateandPuppet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineModel
CreateServerRequest.Builder engineModel(String engineModel)
The engine model of the server. Valid values in this release include
Monolithicfor Puppet andSinglefor Chef.- Parameters:
engineModel- The engine model of the server. Valid values in this release includeMonolithicfor Puppet andSinglefor Chef.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
CreateServerRequest.Builder engineVersion(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 are2019or2017.- Parameters:
engineVersion- The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently2. For a Puppet server, valid values are2019or2017.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineAttributes
CreateServerRequest.Builder engineAttributes(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
engineAttributes
CreateServerRequest.Builder engineAttributes(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
engineAttributes
CreateServerRequest.Builder engineAttributes(Consumer<EngineAttribute.Builder>... 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.
EngineAttribute.Builderavoiding the need to create one manually viaEngineAttribute.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#engineAttributes(List.) - Parameters:
engineAttributes- a consumer that will call methods onEngineAttribute.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#engineAttributes(java.util.Collection)
-
-
backupRetentionCount
CreateServerRequest.Builder backupRetentionCount(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.- Parameters:
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 is1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverName
CreateServerRequest.Builder serverName(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceProfileArn
CreateServerRequest.Builder instanceProfileArn(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceType
CreateServerRequest.Builder instanceType(String instanceType)
The Amazon EC2 instance type to use. For example,
m5.large.- Parameters:
instanceType- The Amazon EC2 instance type to use. For example,m5.large.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyPair
CreateServerRequest.Builder keyPair(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredMaintenanceWindow
CreateServerRequest.Builder preferredMaintenanceWindow(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.MMmust be specified as00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinitionfor more information.Example:
Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)- Parameters:
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.MMmust be specified as00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinitionfor more information.Example:
Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredBackupWindow
CreateServerRequest.Builder preferredBackupWindow(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:MMfor daily backups -
DDD:HH:MMfor weekly backups
MMmust be specified as00. 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.)- Parameters:
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:MMfor daily backups -
DDD:HH:MMfor weekly backups
MMmust be specified as00. 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.)-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
securityGroupIds
CreateServerRequest.Builder securityGroupIds(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).
- Parameters:
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 bySubnetIds.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).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
CreateServerRequest.Builder securityGroupIds(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).
- Parameters:
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 bySubnetIds.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).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceRoleArn
CreateServerRequest.Builder serviceRoleArn(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
CreateServerRequest.Builder subnetIds(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
CreateServerRequest.Builder subnetIds(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateServerRequest.Builder tags(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tags
CreateServerRequest.Builder tags(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tags
CreateServerRequest.Builder tags(Consumer<Tag.Builder>... 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.
Tag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
-
backupId
CreateServerRequest.Builder backupId(String backupId)
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
- Parameters:
backupId- If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-