Skip to content
v2.278.0

RelationalDatabaseParameterProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lightsail as lightsail } from 'aws-cdk-lib';
const relationalDatabaseParameterProperty: lightsail.CfnDatabase.RelationalDatabaseParameterProperty = {
  allowedValues: 'allowedValues',
  applyMethod: 'applyMethod',
  applyType: 'applyType',
  dataType: 'dataType',
  description: 'description',
  isModifiable: false,
  parameterName: 'parameterName',
  parameterValue: 'parameterValue',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lightsail as lightsail

relational_database_parameter_property = lightsail.CfnDatabase.RelationalDatabaseParameterProperty(
    allowed_values="allowedValues",
    apply_method="applyMethod",
    apply_type="applyType",
    data_type="dataType",
    description="description",
    is_modifiable=False,
    parameter_name="parameterName",
    parameter_value="parameterValue"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lightsail;

var relationalDatabaseParameterProperty = new RelationalDatabaseParameterProperty {
    AllowedValues = "allowedValues",
    ApplyMethod = "applyMethod",
    ApplyType = "applyType",
    DataType = "dataType",
    Description = "description",
    IsModifiable = false,
    ParameterName = "parameterName",
    ParameterValue = "parameterValue"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

relationalDatabaseParameterProperty := &RelationalDatabaseParameterProperty{
	AllowedValues: jsii.String("allowedValues"),
	ApplyMethod: jsii.String("applyMethod"),
	ApplyType: jsii.String("applyType"),
	DataType: jsii.String("dataType"),
	Description: jsii.String("description"),
	IsModifiable: jsii.Boolean(false),
	ParameterName: jsii.String("parameterName"),
	ParameterValue: jsii.String("parameterValue"),
}

Properties ​

allowedValuesoptionalstringallowed_valuesoptionalstrallowedValuesoptionalStringAllowedValuesoptionalstringAllowedValuesoptional*string #
The valid range of values for the parameter.
applyMethodoptionalstringapply_methodoptionalstrapplyMethodoptionalStringApplyMethodoptionalstringApplyMethodoptional*string #
Indicates when parameter updates are applied.

Can be immediate or pending-reboot .

applyTypeoptionalstringapply_typeoptionalstrapplyTypeoptionalStringApplyTypeoptionalstringApplyTypeoptional*string #
Specifies the engine-specific parameter type.
dataTypeoptionalstringdata_typeoptionalstrdataTypeoptionalStringDataTypeoptionalstringDataTypeoptional*string #
The valid data type of the parameter.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
A description of the parameter.
isModifiableoptionalboolean | IResolvableis_modifiableoptionaltyping.Union[bool, IResolvable]isModifiableoptionalBooleanIsModifiableoptionalboolIsModifiableoptionalinterface{} #
A Boolean value indicating whether the parameter can be modified.
parameterNameoptionalstringparameter_nameoptionalstrparameterNameoptionalStringParameterNameoptionalstringParameterNameoptional*string #
The name of the parameter.
parameterValueoptionalstringparameter_valueoptionalstrparameterValueoptionalStringParameterValueoptionalstringParameterValueoptional*string #
The value for the parameter.