CfnDBCluster

class aws_cdk.aws_neptune.CfnDBCluster(scope, id, *, associated_roles=None, availability_zones=None, backup_retention_period=None, copy_tags_to_snapshot=None, db_cluster_identifier=None, db_cluster_parameter_group_name=None, db_instance_parameter_group_name=None, db_subnet_group_name=None, deletion_protection=None, enable_cloudwatch_logs_exports=None, engine_version=None, iam_auth_enabled=None, kms_key_id=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, restore_to_time=None, restore_type=None, serverless_scaling_configuration=None, snapshot_identifier=None, source_db_cluster_identifier=None, storage_encrypted=None, tags=None, use_latest_restorable_time=None, vpc_security_group_ids=None)

Bases: CfnResource

A CloudFormation AWS::Neptune::DBCluster.

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

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 AWS CloudFormation deletes resources, see DeletionPolicy Attribute .

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

CloudformationResource:: AWS::Neptune::DBCluster
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_neptune as neptune

cfn_dBCluster = neptune.CfnDBCluster(self, "MyCfnDBCluster",
    associated_roles=[neptune.CfnDBCluster.DBClusterRoleProperty(
        role_arn="roleArn",

        # the properties below are optional
        feature_name="featureName"
    )],
    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_subnet_group_name="dbSubnetGroupName",
    deletion_protection=False,
    enable_cloudwatch_logs_exports=["enableCloudwatchLogsExports"],
    engine_version="engineVersion",
    iam_auth_enabled=False,
    kms_key_id="kmsKeyId",
    port=123,
    preferred_backup_window="preferredBackupWindow",
    preferred_maintenance_window="preferredMaintenanceWindow",
    restore_to_time="restoreToTime",
    restore_type="restoreType",
    serverless_scaling_configuration=neptune.CfnDBCluster.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"]
)

Create a new AWS::Neptune::DBCluster.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
associated_roles (Union[IResolvable, Sequence[Union[DBClusterRoleProperty, Dict[str, Any], IResolvable]], None]) – Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.
availability_zones (Optional[Sequence[str]]) – Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
backup_retention_period (Union[int, float, None]) – Specifies the number of days for which automatic DB snapshots are retained. An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.
copy_tags_to_snapshot (Union[bool, IResolvable, None]) – If set to ``true`` , tags are copied to any snapshot of the DB cluster that is created..
db_cluster_identifier (Optional[str]) – Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
db_cluster_parameter_group_name (Optional[str]) –
Provides the name of the DB cluster parameter group. An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.
db_instance_parameter_group_name (Optional[str]) – The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major engine version upgrade request Note that when you apply a parameter group using DBInstanceParameterGroupName , parameter changes are applied immediately, not during the next maintenance window. Constraints - The DB parameter group must be in the same DB parameter group family as the target DB cluster version. - The DBInstanceParameterGroupName parameter is only valid for major engine version upgrades.
db_subnet_group_name (Optional[str]) – Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
deletion_protection (Union[bool, IResolvable, None]) – Indicates whether or not the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.
enable_cloudwatch_logs_exports (Optional[Sequence[str]]) – Specifies a list of log types that are enabled for export to CloudWatch Logs.
engine_version (Optional[str]) – Indicates the database engine version.
iam_auth_enabled (Union[bool, IResolvable, None]) – True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
kms_key_id (Optional[str]) – If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.
port (Union[int, float, None]) – AWS::Neptune::DBCluster.Port.
preferred_backup_window (Optional[str]) – Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod . An update may require some interruption.
preferred_maintenance_window (Optional[str]) – Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
restore_to_time (Optional[str]) – Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
restore_type (Optional[str]) – Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
serverless_scaling_configuration (Union[IResolvable, ServerlessScalingConfigurationProperty, Dict[str, Any], None]) – AWS::Neptune::DBCluster.ServerlessScalingConfiguration.
snapshot_identifier (Optional[str]) – Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. After you restore a DB cluster using a SnapshotIdentifier , you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don’t specify the SnapshotIdentifier , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier , and the original DB cluster is deleted.
source_db_cluster_identifier (Optional[str]) – Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
storage_encrypted (Union[bool, IResolvable, None]) – Indicates whether the DB cluster is encrypted. If you specify the DBClusterIdentifier , DBSnapshotIdentifier , or SourceDBInstanceIdentifier property, don’t specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption. If you specify the KmsKeyId , you must enable encryption by setting StorageEncrypted to true.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags assigned to this cluster.
use_latest_restorable_time (Union[bool, IResolvable, None]) – Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
vpc_security_group_ids (Optional[Sequence[str]]) – Provides a list of VPC security groups that the DB cluster belongs to.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Neptune::DBCluster'

associated_roles

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-associatedroles

attr_cluster_resource_id

The resource id for the DB cluster.

For example: cluster-ABCD1234EFGH5678IJKL90MNOP . The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.

CloudformationAttribute:: ClusterResourceId

attr_endpoint

The connection endpoint for the DB cluster.

For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

CloudformationAttribute:: Endpoint

attr_port

The port number on which the DB cluster accepts connections.

For example: 8182 .

CloudformationAttribute:: Port

attr_read_endpoint

The reader endpoint for the DB cluster.

For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

CloudformationAttribute:: ReadEndpoint

availability_zones

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-availabilityzones

backup_retention_period

Specifies the number of days for which automatic DB snapshots are retained.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-backupretentionperiod

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

copy_tags_to_snapshot

If set to ``true`` , tags are copied to any snapshot of the DB cluster that is created..

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-copytagstosnapshot

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

db_cluster_identifier

Contains a user-supplied DB cluster identifier.

This identifier is the unique key that identifies a DB cluster.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusteridentifier

db_cluster_parameter_group_name

Provides the name of the DB cluster parameter group.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusterparametergroupname

db_instance_parameter_group_name

The name of the DB parameter group to apply to all instances of the DB cluster.

Used only in case of a major engine version upgrade request

Note that when you apply a parameter group using DBInstanceParameterGroupName , parameter changes are applied immediately, not during the next maintenance window.

Constraints - The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

The DBInstanceParameterGroupName parameter is only valid for major engine version upgrades.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbinstanceparametergroupname

db_subnet_group_name

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbsubnetgroupname

deletion_protection

Indicates whether or not the DB cluster has deletion protection enabled.

The database can’t be deleted when deletion protection is enabled.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-deletionprotection

enable_cloudwatch_logs_exports

Specifies a list of log types that are enabled for export to CloudWatch Logs.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-enablecloudwatchlogsexports

engine_version

Indicates the database engine version.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-engineversion

iam_auth_enabled

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-iamauthenabled

kms_key_id

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-kmskeyid

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

port

AWS::Neptune::DBCluster.Port.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-port

preferred_backup_window

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

An update may require some interruption.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredbackupwindow

preferred_maintenance_window

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredmaintenancewindow

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

restore_to_time

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-restoretotime

restore_type

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-restoretype

serverless_scaling_configuration

AWS::Neptune::DBCluster.ServerlessScalingConfiguration.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-serverlessscalingconfiguration

snapshot_identifier

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a SnapshotIdentifier , you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don’t specify the SnapshotIdentifier , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier , and the original DB cluster is deleted.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-snapshotidentifier

source_db_cluster_identifier

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-sourcedbclusteridentifier

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

storage_encrypted

Indicates whether the DB cluster is encrypted.

If you specify the DBClusterIdentifier , DBSnapshotIdentifier , or SourceDBInstanceIdentifier property, don’t specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.

If you specify the KmsKeyId , you must enable encryption by setting StorageEncrypted to true.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-storageencrypted

tags

The tags assigned to this cluster.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-tags

use_latest_restorable_time

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-uselatestrestorabletime

vpc_security_group_ids

Provides a list of VPC security groups that the DB cluster belongs to.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-vpcsecuritygroupids

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

DBClusterRoleProperty

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

Bases: object

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

Parameters:

role_arn (str) – The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
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 .

Link:

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.
import aws_cdk.aws_neptune as neptune

d_bCluster_role_property = neptune.CfnDBCluster.DBClusterRoleProperty(
    role_arn="roleArn",

    # the properties below are optional
    feature_name="featureName"
)

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 .

Link:: 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.

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

ServerlessScalingConfigurationProperty

class CfnDBCluster.ServerlessScalingConfigurationProperty(*, max_capacity, min_capacity)

Bases: object

Parameters:

max_capacity (Union[int, float]) – CfnDBCluster.ServerlessScalingConfigurationProperty.MaxCapacity.
min_capacity (Union[int, float]) – CfnDBCluster.ServerlessScalingConfigurationProperty.MinCapacity.

Link:

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.
import aws_cdk.aws_neptune as neptune

serverless_scaling_configuration_property = neptune.CfnDBCluster.ServerlessScalingConfigurationProperty(
    max_capacity=123,
    min_capacity=123
)

Attributes

max_capacity

CfnDBCluster.ServerlessScalingConfigurationProperty.MaxCapacity.

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

min_capacity

CfnDBCluster.ServerlessScalingConfigurationProperty.MinCapacity.

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