InstanceProps

All Known Implementing Classes:: InstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:20.679Z")
public interface InstanceProps

Properties of an EC2 Instance.

Example:

 Vpc vpc;
 InstanceType instanceType;
 IMachineImage machineImage;
 Instance.Builder.create(this, "Instance")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         // ...
         .blockDevices(List.of(BlockDevice.builder()
                 .deviceName("/dev/sda1")
                 .volume(BlockDeviceVolume.ebs(50))
                 .build(), BlockDevice.builder()
                 .deviceName("/dev/sdm")
                 .volume(BlockDeviceVolume.ebs(100))
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`InstanceProps.Builder` A builder for `InstanceProps`
`static class`	`InstanceProps.Jsii$Proxy` An implementation for `InstanceProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static InstanceProps.Builder`	`builder()`
`default java.lang.Boolean`	`getAllowAllOutbound()` Whether the instance could initiate connections to anywhere by default.
`default java.lang.String`	`getAvailabilityZone()` In which AZ to place the instance within the VPC.
`default java.util.List<BlockDevice>`	`getBlockDevices()` Specifies how block devices are exposed to the instance.
`default java.lang.Boolean`	`getDetailedMonitoring()` Whether "Detailed Monitoring" is enabled for this instance Keep in mind that Detailed Monitoring results in extra charges.
`default CloudFormationInit`	`getInit()` Apply the given CloudFormation Init configuration to the instance at startup.
`default ApplyCloudFormationInitOptions`	`getInitOptions()` Use the given options for applying CloudFormation Init.
`default java.lang.String`	`getInstanceName()` The name of the instance.
`InstanceType`	`getInstanceType()` Type of instance to launch.
`default java.lang.String`	`getKeyName()` Name of SSH keypair to grant access to instance.
`IMachineImage`	`getMachineImage()` AMI to launch.
`default java.lang.String`	`getPrivateIpAddress()` Defines a private IP address to associate with an instance.
`default java.lang.Boolean`	`getPropagateTagsToVolumeOnCreation()` Propagate the EC2 instance tags to the EBS volumes.
`default java.lang.Boolean`	`getRequireImdsv2()` Whether IMDSv2 should be required on this instance.
`default Duration`	`getResourceSignalTimeout()` The length of time to wait for the resourceSignalCount.
`default IRole`	`getRole()` An IAM role to associate with the instance profile assigned to this Auto Scaling Group.
`default ISecurityGroup`	`getSecurityGroup()` Security Group to assign to this instance.
`default java.lang.Boolean`	`getSourceDestCheck()` Specifies whether to enable an instance launched in a VPC to perform NAT.
`default UserData`	`getUserData()` Specific UserData to use.
`default java.lang.Boolean`	`getUserDataCausesReplacement()` Changes to the UserData force replacement.
`IVpc`	`getVpc()` VPC to launch the instance in.
`default SubnetSelection`	`getVpcSubnets()` Where to place the instance within the VPC.

- Method Detail
  - getInstanceType
```
InstanceType getInstanceType()
```
    Type of instance to launch.
  - getMachineImage
```
IMachineImage getMachineImage()
```
    AMI to launch.
  - getVpc
```
IVpc getVpc()
```
    VPC to launch the instance in.
  - getAllowAllOutbound
```
default java.lang.Boolean getAllowAllOutbound()
```
    Whether the instance could initiate connections to anywhere by default.
    This property is only used when you do not provide a security group.
    Default: true
  - getAvailabilityZone
```
default java.lang.String getAvailabilityZone()
```
    In which AZ to place the instance within the VPC.
    Default: - Random zone.
  - getBlockDevices
```
default java.util.List<BlockDevice> getBlockDevices()
```
    Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
    Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
    Default: - Uses the block device mapping of the AMI
    
    See Also:
    
    https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
  - getDetailedMonitoring
```
default java.lang.Boolean getDetailedMonitoring()
```
    Whether "Detailed Monitoring" is enabled for this instance Keep in mind that Detailed Monitoring results in extra charges.
    Default: - false
    
    See Also:
    
    http://aws.amazon.com/cloudwatch/pricing/
  - getInit
```
default CloudFormationInit getInit()
```
    Apply the given CloudFormation Init configuration to the instance at startup.
    Default: - no CloudFormation init
  - getInitOptions
```
default ApplyCloudFormationInitOptions getInitOptions()
```
    Use the given options for applying CloudFormation Init.
    Describes the configsets to use and the timeout to wait
    Default: - default options
  - getInstanceName
```
default java.lang.String getInstanceName()
```
    The name of the instance.
    Default: - CDK generated name
  - getKeyName
```
default java.lang.String getKeyName()
```
    Name of SSH keypair to grant access to instance.
    Default: - No SSH access will be possible.
  - getPrivateIpAddress
```
default java.lang.String getPrivateIpAddress()
```
    Defines a private IP address to associate with an instance.
    Private IP should be available within the VPC that the instance is build within.
    Default: - no association
  - getPropagateTagsToVolumeOnCreation
```
default java.lang.Boolean getPropagateTagsToVolumeOnCreation()
```
    Propagate the EC2 instance tags to the EBS volumes.
    Default: - false
  - getRequireImdsv2
```
default java.lang.Boolean getRequireImdsv2()
```
    Whether IMDSv2 should be required on this instance.
    Default: - false
  - getResourceSignalTimeout
```
default Duration getResourceSignalTimeout()
```
    The length of time to wait for the resourceSignalCount.
    The maximum value is 43200 (12 hours).
    Default: Duration.minutes(5)
  - getRole
```
default IRole getRole()
```
    An IAM role to associate with the instance profile assigned to this Auto Scaling Group.
    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
    Example:
    Role role = Role.Builder.create(this, "MyRole") .assumedBy(new ServicePrincipal("ec2.amazonaws.com")) .build();
  - getSecurityGroup
```
default ISecurityGroup getSecurityGroup()
```
    Security Group to assign to this instance.
    Default: - create new security group
  - getSourceDestCheck
```
default java.lang.Boolean getSourceDestCheck()
```
    Specifies whether to enable an instance launched in a VPC to perform NAT.
    This controls whether source/destination checking is enabled on the instance. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform NAT.
    Default: true
  - getUserData
```
default UserData getUserData()
```
    Specific UserData to use.
    The UserData may still be mutated after creation.
    Default: - A UserData object appropriate for the MachineImage's Operating System is created.
  - getUserDataCausesReplacement
```
default java.lang.Boolean getUserDataCausesReplacement()
```
    Changes to the UserData force replacement.
    Depending the EC2 instance type, changing UserData either restarts the instance or replaces the instance.
    - Instance store-backed instances are replaced.
    - EBS-backed instances are restarted.
    By default, restarting does not execute the new UserData so you will need a different mechanism to ensure the instance is restarted.
    Setting this to true will make the instance's Logical ID depend on the UserData, which will cause CloudFormation to replace it if the UserData changes.
    Default: - true iff `initOptions` is specified, false otherwise.
  - getVpcSubnets
```
default SubnetSelection getVpcSubnets()
```
    Where to place the instance within the VPC.
    Default: - Private subnets.
  - builder
```
static InstanceProps.Builder builder()
```
    Returns:
    
    a InstanceProps.Builder of InstanceProps

Interface InstanceProps

Nested Class Summary

Method Summary

Method Detail

getInstanceType

getMachineImage

getVpc

getAllowAllOutbound

getAvailabilityZone

getBlockDevices

getDetailedMonitoring

getInit

getInitOptions

getInstanceName

getKeyName

getPrivateIpAddress

getPropagateTagsToVolumeOnCreation

getRequireImdsv2

getResourceSignalTimeout

getRole

getSecurityGroup

getSourceDestCheck

getUserData

getUserDataCausesReplacement

getVpcSubnets

builder