MongoDbInstanceProps

class aws_rfdk.MongoDbInstanceProps(*, mongo_db, vpc, instance_type=None, key_name=None, log_group_props=None, role=None, security_group=None, vpc_subnets=None)

Bases: object

Properties for a newly created {@link MongoDbInstance}.

Parameters
  • mongo_db (Union[MongoDbApplicationProps, Dict[str, Any]]) – Properties for the MongoDB application that will be running on the instance.

  • vpc (IVpc) – The VPC in which to create the MongoDbInstance.

  • instance_type (Optional[InstanceType]) – The type of instance to launch. Note that this must be an x86-64 instance type. Default: r5.large

  • key_name (Optional[str]) – Name of the EC2 SSH keypair to grant access to the instance. Default: No SSH access will be possible.

  • log_group_props (Union[LogGroupFactoryProps, Dict[str, Any], None]) – Properties for setting up the MongoDB Instance’s LogGroup in CloudWatch. Default: - LogGroup will be created with all properties’ default values to the LogGroup: /renderfarm/

  • role (Optional[IRole]) – An IAM role to associate with the instance profile that is assigned to this instance. The role must be assumable by the service principal ec2.amazonaws.com Default: A role will automatically be created, it can be accessed via the role property.

  • security_group (Optional[ISecurityGroup]) – The security group to assign to this instance. Default: A new security group is created for this instance.

  • vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – Where to place the instance within the VPC. Default: The instance is placed within a Private subnet.

Attributes

instance_type

The type of instance to launch.

Note that this must be an x86-64 instance type.

Default

r5.large

Return type

Optional[InstanceType]

key_name

Name of the EC2 SSH keypair to grant access to the instance.

Default

No SSH access will be possible.

Return type

Optional[str]

log_group_props

Properties for setting up the MongoDB Instance’s LogGroup in CloudWatch.

Default
  • LogGroup will be created with all properties’ default values to the LogGroup: /renderfarm/

Return type

Optional[LogGroupFactoryProps]

mongo_db

Properties for the MongoDB application that will be running on the instance.

Return type

MongoDbApplicationProps

role

An IAM role to associate with the instance profile that is assigned to this instance.

The role must be assumable by the service principal ec2.amazonaws.com

Default

A role will automatically be created, it can be accessed via the role property.

Return type

Optional[IRole]

security_group

The security group to assign to this instance.

Default

A new security group is created for this instance.

Return type

Optional[ISecurityGroup]

vpc

The VPC in which to create the MongoDbInstance.

Return type

IVpc

vpc_subnets

Where to place the instance within the VPC.

Default

The instance is placed within a Private subnet.

Return type

Optional[SubnetSelection]