InstanceProps

class aws_cdk.aws_docdb.InstanceProps(*, instance_type, vpc, parameter_group=None, security_group=None, vpc_subnets=None)

Bases: object

__init__(*, instance_type, vpc, parameter_group=None, security_group=None, vpc_subnets=None)

Instance properties for database instances.

Parameters
  • instance_type (InstanceType) – What type of instance to start for the replicas.

  • vpc (IVpc) – What subnets to run the DocumentDB instances in. Must be at least 2 subnets in two different AZs.

  • parameter_group (Optional[IClusterParameterGroup]) – The DB parameter group to associate with the instance. Default: no parameter group

  • security_group (Optional[ISecurityGroup]) – Security group. Default: a new security group is created.

  • vpc_subnets (Optional[SubnetSelection]) – Where to place the instances within the VPC. Default: private subnets

stability :stability: experimental

Return type

None

Attributes

instance_type

What type of instance to start for the replicas.

stability :stability: experimental

Return type

InstanceType

parameter_group

The DB parameter group to associate with the instance.

default :default: no parameter group

stability :stability: experimental

Return type

Optional[IClusterParameterGroup]

security_group

Security group.

default :default: a new security group is created.

stability :stability: experimental

Return type

Optional[ISecurityGroup]

vpc

What subnets to run the DocumentDB instances in.

Must be at least 2 subnets in two different AZs.

stability :stability: experimental

Return type

IVpc

vpc_subnets

Where to place the instances within the VPC.

default :default: private subnets

stability :stability: experimental

Return type

Optional[SubnetSelection]