CfnDBClusterPropsMixin

class aws_cdk.mixins_preview.aws_neptune.mixins.CfnDBClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database.

Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported.

If no DeletionPolicy is set for AWS::Neptune::DBCluster resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the DeletionPolicy should be set to Snapshot . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .

You can use AWS::Neptune::DBCluster.DeletionProtection to help guard against unintended deletion of your DB cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html
CloudformationResource:: AWS::Neptune::DBCluster
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_neptune import mixins as neptune_mixins

cfn_dBCluster_props_mixin = neptune_mixins.CfnDBClusterPropsMixin(neptune_mixins.CfnDBClusterMixinProps(
    associated_roles=[neptune_mixins.CfnDBClusterPropsMixin.DBClusterRoleProperty(
        feature_name="featureName",
        role_arn="roleArn"
    )],
    availability_zones=["availabilityZones"],
    backup_retention_period=123,
    copy_tags_to_snapshot=False,
    db_cluster_identifier="dbClusterIdentifier",
    db_cluster_parameter_group_name="dbClusterParameterGroupName",
    db_instance_parameter_group_name="dbInstanceParameterGroupName",
    db_port=123,
    db_subnet_group_name="dbSubnetGroupName",
    deletion_protection=False,
    enable_cloudwatch_logs_exports=["enableCloudwatchLogsExports"],
    engine_version="engineVersion",
    iam_auth_enabled=False,
    kms_key_id="kmsKeyId",
    preferred_backup_window="preferredBackupWindow",
    preferred_maintenance_window="preferredMaintenanceWindow",
    restore_to_time="restoreToTime",
    restore_type="restoreType",
    serverless_scaling_configuration=neptune_mixins.CfnDBClusterPropsMixin.ServerlessScalingConfigurationProperty(
        max_capacity=123,
        min_capacity=123
    ),
    snapshot_identifier="snapshotIdentifier",
    source_db_cluster_identifier="sourceDbClusterIdentifier",
    storage_encrypted=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    use_latest_restorable_time=False,
    vpc_security_group_ids=["vpcSecurityGroupIds"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Neptune::DBCluster.

Parameters:

props (Union[CfnDBClusterMixinProps, 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 = ['associatedRoles', 'availabilityZones', 'backupRetentionPeriod', 'copyTagsToSnapshot', 'dbClusterIdentifier', 'dbClusterParameterGroupName', 'dbInstanceParameterGroupName', 'dbPort', 'dbSubnetGroupName', 'deletionProtection', 'enableCloudwatchLogsExports', 'engineVersion', 'iamAuthEnabled', 'kmsKeyId', 'preferredBackupWindow', 'preferredMaintenanceWindow', 'restoreToTime', 'restoreType', 'serverlessScalingConfiguration', 'snapshotIdentifier', 'sourceDbClusterIdentifier', 'storageEncrypted', 'tags', 'useLatestRestorableTime', 'vpcSecurityGroupIds']

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

DBClusterRoleProperty

class CfnDBClusterPropsMixin.DBClusterRoleProperty(*, feature_name=None, role_arn=None)

Bases: object

Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.

Parameters:

feature_name (Optional[str]) – The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions .
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-dbclusterrole.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_neptune import mixins as neptune_mixins

d_bCluster_role_property = neptune_mixins.CfnDBClusterPropsMixin.DBClusterRoleProperty(
    feature_name="featureName",
    role_arn="roleArn"
)

Attributes

feature_name

The name of the feature associated with the Amazon Identity and Access Management (IAM) role.

For the list of supported feature names, see DescribeDBEngineVersions .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-dbclusterrole.html#cfn-neptune-dbcluster-dbclusterrole-featurename

role_arn

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-dbclusterrole.html#cfn-neptune-dbcluster-dbclusterrole-rolearn

ServerlessScalingConfigurationProperty

class CfnDBClusterPropsMixin.ServerlessScalingConfigurationProperty(*, max_capacity=None, min_capacity=None)

Bases: object

Contains the scaling configuration of a Neptune Serverless DB cluster.

Parameters:

max_capacity (Union[int, float, None]) – The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.
min_capacity (Union[int, float, None]) – The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-serverlessscalingconfiguration.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_neptune import mixins as neptune_mixins

serverless_scaling_configuration_property = neptune_mixins.CfnDBClusterPropsMixin.ServerlessScalingConfigurationProperty(
    max_capacity=123,
    min_capacity=123
)

Attributes

max_capacity

The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster.

You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-serverlessscalingconfiguration.html#cfn-neptune-dbcluster-serverlessscalingconfiguration-maxcapacity

min_capacity

The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster.

You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-serverlessscalingconfiguration.html#cfn-neptune-dbcluster-serverlessscalingconfiguration-mincapacity