software.amazon.awscdk.services.ec2

Class Instance

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.Instance

All Implemented Interfaces:

IResource, IConnectable, IInstance, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.451Z")
 @Stability(value=Stable)
public class Instance
extends Resource
implements IInstance

This represents a single EC2 instance.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 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	Class and Description
static class	Instance.Builder A fluent builder for Instance.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IInstance

IInstance.Jsii$Default, IInstance.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Instance(software.constructs.Construct scope, String id, InstanceProps props)
protected	Instance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Instance(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addSecurityGroup(ISecurityGroup securityGroup) Add the security group to the instance.
void	addToRolePolicy(PolicyStatement statement) Adds a statement to the IAM role assumed by the instance.
void	addUserData(String... commands) Add command to the startup script of the instance.
Connections	getConnections() Allows specify security group connections for the instance.
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
CfnInstance	getInstance() the underlying instance resource.
String	getInstanceAvailabilityZone() The availability zone the instance was launched in.
String	getInstanceId() The instance's ID.
String	getInstancePrivateDnsName() Private DNS name for this instance.
String	getInstancePrivateIp() Private IP for this instance.
String	getInstancePublicDnsName() Publicly-routable DNS name for this instance.
String	getInstancePublicIp() Publicly-routable IP address for this instance.
OperatingSystemType	getOsType() The type of OS the instance is running.
IRole	getRole() The IAM role assumed by the instance.
UserData	getUserData() UserData for the instance.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Instance

protected Instance(software.amazon.jsii.JsiiObjectRef objRef)

Instance

protected Instance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Instance

@Stability(value=Stable)
public Instance(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         InstanceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addSecurityGroup

@Stability(value=Stable)
public void addSecurityGroup(@NotNull
                                                      ISecurityGroup securityGroup)

Add the security group to the instance.

Parameters:

securityGroup - : The security group to add. This parameter is required.

addToRolePolicy

@Stability(value=Stable)
public void addToRolePolicy(@NotNull
                                                     PolicyStatement statement)

Adds a statement to the IAM role assumed by the instance.

Parameters:

statement - This parameter is required.

addUserData

@Stability(value=Stable)
public void addUserData(@NotNull
                                                 String... commands)

Add command to the startup script of the instance.

The command must be in the scripting language supported by the instance's OS (i.e. Linux/Windows).

Parameters:

commands - This parameter is required.

getConnections

@Stability(value=Stable)
 @NotNull
public Connections getConnections()

Allows specify security group connections for the instance.

Specified by:

getConnections in interface IConnectable

getGrantPrincipal

@Stability(value=Stable)
 @NotNull
public IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getInstance

@Stability(value=Stable)
 @NotNull
public CfnInstance getInstance()

the underlying instance resource.

getInstanceAvailabilityZone

@Stability(value=Stable)
 @NotNull
public String getInstanceAvailabilityZone()

The availability zone the instance was launched in.

Specified by:

getInstanceAvailabilityZone in interface IInstance

getInstanceId

@Stability(value=Stable)
 @NotNull
public String getInstanceId()

The instance's ID.

Specified by:

getInstanceId in interface IInstance

getInstancePrivateDnsName

@Stability(value=Stable)
 @NotNull
public String getInstancePrivateDnsName()

Private DNS name for this instance.

Specified by:

getInstancePrivateDnsName in interface IInstance

getInstancePrivateIp

@Stability(value=Stable)
 @NotNull
public String getInstancePrivateIp()

Private IP for this instance.

Specified by:

getInstancePrivateIp in interface IInstance

getInstancePublicDnsName

@Stability(value=Stable)
 @NotNull
public String getInstancePublicDnsName()

Publicly-routable DNS name for this instance.

(May be an empty string if the instance does not have a public name).

Specified by:

getInstancePublicDnsName in interface IInstance

getInstancePublicIp

@Stability(value=Stable)
 @NotNull
public String getInstancePublicIp()

Publicly-routable IP address for this instance.

(May be an empty string if the instance does not have a public IP).

Specified by:

getInstancePublicIp in interface IInstance

getOsType

@Stability(value=Stable)
 @NotNull
public OperatingSystemType getOsType()

The type of OS the instance is running.

getRole

@Stability(value=Stable)
 @NotNull
public IRole getRole()

The IAM role assumed by the instance.

getUserData

@Stability(value=Stable)
 @NotNull
public UserData getUserData()

UserData for the instance.