Class CfnDBShardGroupProps

Properties for defining a CfnDBShardGroup.

Inheritance

object

CfnDBShardGroupProps

Implements

ICfnDBShardGroupProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDBShardGroupProps : ICfnDBShardGroupProps

Syntax (vb)

Public Class CfnDBShardGroupProps Implements ICfnDBShardGroupProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var cfnDBShardGroupProps = new CfnDBShardGroupProps {
                 DbClusterIdentifier = "dbClusterIdentifier",
                 MaxAcu = 123,

                 // the properties below are optional
                 ComputeRedundancy = 123,
                 DbShardGroupIdentifier = "dbShardGroupIdentifier",
                 MinAcu = 123,
                 PubliclyAccessible = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnDBShardGroupProps()

Properties for defining a CfnDBShardGroup.

Properties

ComputeRedundancy	Specifies whether to create standby standby DB data access shard for the DB shard group.
DbClusterIdentifier	The name of the primary DB cluster for the DB shard group.
DbShardGroupIdentifier	The name of the DB shard group.
MaxAcu	The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
MinAcu	The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
PubliclyAccessible	Specifies whether the DB shard group is publicly accessible.
Tags	An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.

Constructors

CfnDBShardGroupProps()

Properties for defining a CfnDBShardGroup.

public CfnDBShardGroupProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var cfnDBShardGroupProps = new CfnDBShardGroupProps {
                 DbClusterIdentifier = "dbClusterIdentifier",
                 MaxAcu = 123,

                 // the properties below are optional
                 ComputeRedundancy = 123,
                 DbShardGroupIdentifier = "dbShardGroupIdentifier",
                 MinAcu = 123,
                 PubliclyAccessible = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

ComputeRedundancy

Specifies whether to create standby standby DB data access shard for the DB shard group.

public double? ComputeRedundancy { get; set; }

Property Value

double?

Remarks

Valid values are the following:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-computeredundancy

DbClusterIdentifier

The name of the primary DB cluster for the DB shard group.

public string DbClusterIdentifier { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-dbclusteridentifier

DbShardGroupIdentifier

The name of the DB shard group.

public string? DbShardGroupIdentifier { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-dbshardgroupidentifier

MaxAcu

The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

public double MaxAcu { get; set; }

Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-maxacu

MinAcu

The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

public double? MinAcu { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-minacu

PubliclyAccessible

Specifies whether the DB shard group is publicly accessible.

public object? PubliclyAccessible { get; set; }

Property Value

object

Remarks

When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.

When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-publiclyaccessible

Type union: either bool or IResolvable

Implements

ICfnDBShardGroupProps