InstanceProps

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

Bases: object

(experimental) Instance properties for database instances.

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

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

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

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

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

Stability

experimental

Attributes

instance_type

(experimental) What type of instance to start for the replicas.

Stability

experimental

Return type

InstanceType

parameter_group

(experimental) The DB parameter group to associate with the instance.

Default

no parameter group

Stability

experimental

Return type

Optional[IClusterParameterGroup]

security_group

(experimental) Security group.

Default

a new security group is created.

Stability

experimental

Return type

Optional[ISecurityGroup]

vpc

(experimental) What subnets to run the DocumentDB instances in.

Must be at least 2 subnets in two different AZs.

Stability

experimental

Return type

IVpc

vpc_subnets

(experimental) Where to place the instances within the VPC.

Default

private subnets

Stability

experimental

Return type

Optional[SubnetSelection]