CfnDatabasePropsMixin

class aws_cdk.mixins_preview.aws_lightsail.mixins.CfnDatabasePropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Lightsail::Database resource specifies an Amazon Lightsail database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html

CloudformationResource:

AWS::Lightsail::Database

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_lightsail import mixins as lightsail_mixins

cfn_database_props_mixin = lightsail_mixins.CfnDatabasePropsMixin(lightsail_mixins.CfnDatabaseMixinProps(
    availability_zone="availabilityZone",
    backup_retention=False,
    ca_certificate_identifier="caCertificateIdentifier",
    master_database_name="masterDatabaseName",
    master_username="masterUsername",
    master_user_password="masterUserPassword",
    preferred_backup_window="preferredBackupWindow",
    preferred_maintenance_window="preferredMaintenanceWindow",
    publicly_accessible=False,
    relational_database_blueprint_id="relationalDatabaseBlueprintId",
    relational_database_bundle_id="relationalDatabaseBundleId",
    relational_database_name="relationalDatabaseName",
    relational_database_parameters=[lightsail_mixins.CfnDatabasePropsMixin.RelationalDatabaseParameterProperty(
        allowed_values="allowedValues",
        apply_method="applyMethod",
        apply_type="applyType",
        data_type="dataType",
        description="description",
        is_modifiable=False,
        parameter_name="parameterName",
        parameter_value="parameterValue"
    )],
    rotate_master_user_password=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Lightsail::Database.

Parameters:
  • props (Union[CfnDatabaseMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['availabilityZone', 'backupRetention', 'caCertificateIdentifier', 'masterDatabaseName', 'masterUsername', 'masterUserPassword', 'preferredBackupWindow', 'preferredMaintenanceWindow', 'publiclyAccessible', 'relationalDatabaseBlueprintId', 'relationalDatabaseBundleId', 'relationalDatabaseName', 'relationalDatabaseParameters', 'rotateMasterUserPassword', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

RelationalDatabaseParameterProperty

class CfnDatabasePropsMixin.RelationalDatabaseParameterProperty(*, allowed_values=None, apply_method=None, apply_type=None, data_type=None, description=None, is_modifiable=None, parameter_name=None, parameter_value=None)

Bases: object

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

Parameters:
  • allowed_values (Optional[str]) – The valid range of values for the parameter.

  • apply_method (Optional[str]) – Indicates when parameter updates are applied. Can be immediate or pending-reboot .

  • apply_type (Optional[str]) – Specifies the engine-specific parameter type.

  • data_type (Optional[str]) – The valid data type of the parameter.

  • description (Optional[str]) – A description of the parameter.

  • is_modifiable (Union[bool, IResolvable, None]) – A Boolean value indicating whether the parameter can be modified.

  • parameter_name (Optional[str]) – The name of the parameter.

  • parameter_value (Optional[str]) – The value for the parameter.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_lightsail import mixins as lightsail_mixins

relational_database_parameter_property = lightsail_mixins.CfnDatabasePropsMixin.RelationalDatabaseParameterProperty(
    allowed_values="allowedValues",
    apply_method="applyMethod",
    apply_type="applyType",
    data_type="dataType",
    description="description",
    is_modifiable=False,
    parameter_name="parameterName",
    parameter_value="parameterValue"
)

Attributes

allowed_values

The valid range of values for the parameter.

See:

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

apply_method

Indicates when parameter updates are applied.

Can be immediate or pending-reboot .

See:

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

apply_type

Specifies the engine-specific parameter type.

See:

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

data_type

The valid data type of the parameter.

See:

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

description

A description of the parameter.

See:

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

is_modifiable

A Boolean value indicating whether the parameter can be modified.

See:

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

parameter_name

The name of the parameter.

See:

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

parameter_value

The value for the parameter.

See:

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