Class CreateRelationalDatabaseRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateRelationalDatabaseRequest.Builder,
CreateRelationalDatabaseRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Availability Zone in which to create your new database.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The meaning of this parameter differs according to the database engine you use.final String
The name for the master user.final String
The password for the master user.final String
The daily time range during which automated backups are created for your new database if automated backups are enabled.final String
The weekly time range during which system maintenance can occur on your new database.final Boolean
Specifies the accessibility options for your new database.final String
The blueprint ID for your new database.final String
The bundle ID for your new database.final String
The name to use for your new Lightsail database resource.static Class
<? extends CreateRelationalDatabaseRequest.Builder> tags()
The tag keys and optional values to add to the resource during create.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
relationalDatabaseName
The name to use for your new Lightsail database resource.
Constraints:
-
Must contain from 2 to 255 alphanumeric characters, or hyphens.
-
The first and last character must be a letter or number.
- Returns:
- The name to use for your new Lightsail database resource.
Constraints:
-
Must contain from 2 to 255 alphanumeric characters, or hyphens.
-
The first and last character must be a letter or number.
-
-
-
availabilityZone
The Availability Zone in which to create your new database. Use the
us-east-2a
case-sensitive format.You can get a list of Availability Zones by using the
get regions
operation. Be sure to add theinclude relational database Availability Zones
parameter to your request.- Returns:
- The Availability Zone in which to create your new database. Use the
us-east-2a
case-sensitive format.You can get a list of Availability Zones by using the
get regions
operation. Be sure to add theinclude relational database Availability Zones
parameter to your request.
-
relationalDatabaseBlueprintId
The blueprint ID for your new database. A blueprint describes the major engine version of a database.
You can get a list of database blueprints IDs by using the
get relational database blueprints
operation.- Returns:
- The blueprint ID for your new database. A blueprint describes the major engine version of a database.
You can get a list of database blueprints IDs by using the
get relational database blueprints
operation.
-
relationalDatabaseBundleId
The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the
get relational database bundles
operation.- Returns:
- The bundle ID for your new database. A bundle describes the performance specifications for your
database.
You can get a list of database bundle IDs by using the
get relational database bundles
operation.
-
masterDatabaseName
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.
Constraints:
-
Must contain 1 to 64 letters or numbers.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).
-
Can't be a word reserved by the specified database engine.
For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.
PostgreSQL
The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named
postgres
is created in the database resource.Constraints:
-
Must contain 1 to 63 letters or numbers.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).
-
Can't be a word reserved by the specified database engine.
For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.
- Returns:
- The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.
Constraints:
-
Must contain 1 to 64 letters or numbers.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).
-
Can't be a word reserved by the specified database engine.
For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.
PostgreSQL
The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named
postgres
is created in the database resource.Constraints:
-
Must contain 1 to 63 letters or numbers.
-
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).
-
Can't be a word reserved by the specified database engine.
For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.
-
-
-
masterUsername
The name for the master user.
MySQL
Constraints:
-
Required for MySQL.
-
Must be 1 to 16 letters or numbers. Can contain underscores.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.
PostgreSQL
Constraints:
-
Required for PostgreSQL.
-
Must be 1 to 63 letters or numbers. Can contain underscores.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.
- Returns:
- The name for the master user.
MySQL
Constraints:
-
Required for MySQL.
-
Must be 1 to 16 letters or numbers. Can contain underscores.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.
PostgreSQL
Constraints:
-
Required for PostgreSQL.
-
Must be 1 to 63 letters or numbers. Can contain underscores.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.
-
-
-
masterUserPassword
The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
MySQL
Constraints: Must contain from 8 to 41 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
- Returns:
- The password for the master user. The password can include any printable ASCII character except "/",
""", or "@". It cannot contain spaces.
MySQL
Constraints: Must contain from 8 to 41 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
-
preferredBackupWindow
The daily time range during which automated backups are created for your new database if automated backups are enabled.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service documentation.
Constraints:
-
Must be in the
hh24:mi-hh24:mi
format.Example:
16:00-16:30
-
Specified in Coordinated Universal Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
- Returns:
- The daily time range during which automated backups are created for your new database if automated
backups are enabled.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service documentation.
Constraints:
-
Must be in the
hh24:mi-hh24:mi
format.Example:
16:00-16:30
-
Specified in Coordinated Universal Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
-
-
-
preferredMaintenanceWindow
The weekly time range during which system maintenance can occur on your new database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
-
Must be in the
ddd:hh24:mi-ddd:hh24:mi
format. -
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
-
Must be at least 30 minutes.
-
Specified in Coordinated Universal Time (UTC).
-
Example:
Tue:17:00-Tue:17:30
- Returns:
- The weekly time range during which system maintenance can occur on your new database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
-
Must be in the
ddd:hh24:mi-ddd:hh24:mi
format. -
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
-
Must be at least 30 minutes.
-
Specified in Coordinated Universal Time (UTC).
-
Example:
Tue:17:00-Tue:17:30
-
-
-
publiclyAccessible
Specifies the accessibility options for your new database. A value of
true
specifies a database that is available to resources outside of your Lightsail account. A value offalse
specifies a database that is available only to your Lightsail resources in the same region as your database.- Returns:
- Specifies the accessibility options for your new database. A value of
true
specifies a database that is available to resources outside of your Lightsail account. A value offalse
specifies a database that is available only to your Lightsail resources in the same region as your database.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateRelationalDatabaseRequest.Builder,
CreateRelationalDatabaseRequest> - Specified by:
toBuilder
in classLightsailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-