Package software.amazon.awscdk.services.lightsail

Interface CfnDatabase.RelationalDatabaseParameterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatabase.RelationalDatabaseParameterProperty.Jsii$Proxy

Enclosing class:

CfnDatabase

@Stability(Stable)
public static interface CfnDatabase.RelationalDatabaseParameterProperty
extends software.amazon.jsii.JsiiSerializable

RelationalDatabaseParameter is a property of the AWS::Lightsail::Database resource. It describes parameters for the database.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lightsail.*;
 RelationalDatabaseParameterProperty relationalDatabaseParameterProperty = RelationalDatabaseParameterProperty.builder()
         .allowedValues("allowedValues")
         .applyMethod("applyMethod")
         .applyType("applyType")
         .dataType("dataType")
         .description("description")
         .isModifiable(false)
         .parameterName("parameterName")
         .parameterValue("parameterValue")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDatabase.RelationalDatabaseParameterProperty.Builder	A builder for CfnDatabase.RelationalDatabaseParameterProperty
static final class	CfnDatabase.RelationalDatabaseParameterProperty.Jsii$Proxy	An implementation for CfnDatabase.RelationalDatabaseParameterProperty

Method Summary

Modifier and Type	Method	Description
static CfnDatabase.RelationalDatabaseParameterProperty.Builder	builder()
default String	getAllowedValues()	The valid range of values for the parameter.
default String	getApplyMethod()	Indicates when parameter updates are applied.
default String	getApplyType()	Specifies the engine-specific parameter type.
default String	getDataType()	The valid data type of the parameter.
default String	getDescription()	A description of the parameter.
default Object	getIsModifiable()	A Boolean value indicating whether the parameter can be modified.
default String	getParameterName()	The name of the parameter.
default String	getParameterValue()	The value for the parameter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowedValues

@Stability(Stable)
@Nullable
default String getAllowedValues()

The valid range of values for the parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-allowedvalues

getApplyMethod

@Stability(Stable)
@Nullable
default String getApplyMethod()

Indicates when parameter updates are applied.

Can be immediate or pending-reboot .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-applymethod

getApplyType

@Stability(Stable)
@Nullable
default String getApplyType()

Specifies the engine-specific parameter type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-applytype

getDataType

@Stability(Stable)
@Nullable
default String getDataType()

The valid data type of the parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-datatype

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-description

getIsModifiable

@Stability(Stable)
@Nullable
default Object getIsModifiable()

A Boolean value indicating whether the parameter can be modified.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-ismodifiable

getParameterName

@Stability(Stable)
@Nullable
default String getParameterName()

The name of the parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-parametername

getParameterValue

@Stability(Stable)
@Nullable
default String getParameterValue()

The value for the parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-parametervalue

builder

@Stability(Stable)
static CfnDatabase.RelationalDatabaseParameterProperty.Builder builder()

Returns:

a CfnDatabase.RelationalDatabaseParameterProperty.Builder of CfnDatabase.RelationalDatabaseParameterProperty