software.amazon.awscdk.services.opsworks

Class CfnInstance

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.opsworks.CfnInstance

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.414Z")
 @Stability(value=Stable)
public class CfnInstance
extends CfnResource
implements IInspectable

A CloudFormation `AWS::OpsWorks::Instance`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opsworks.*;
 CfnInstance cfnInstance = CfnInstance.Builder.create(this, "MyCfnInstance")
         .instanceType("instanceType")
         .layerIds(List.of("layerIds"))
         .stackId("stackId")
         // the properties below are optional
         .agentVersion("agentVersion")
         .amiId("amiId")
         .architecture("architecture")
         .autoScalingType("autoScalingType")
         .availabilityZone("availabilityZone")
         .blockDeviceMappings(List.of(BlockDeviceMappingProperty.builder()
                 .deviceName("deviceName")
                 .ebs(EbsBlockDeviceProperty.builder()
                         .deleteOnTermination(false)
                         .iops(123)
                         .snapshotId("snapshotId")
                         .volumeSize(123)
                         .volumeType("volumeType")
                         .build())
                 .noDevice("noDevice")
                 .virtualName("virtualName")
                 .build()))
         .ebsOptimized(false)
         .elasticIps(List.of("elasticIps"))
         .hostname("hostname")
         .installUpdatesOnBoot(false)
         .os("os")
         .rootDeviceType("rootDeviceType")
         .sshKeyName("sshKeyName")
         .subnetId("subnetId")
         .tenancy("tenancy")
         .timeBasedAutoScaling(TimeBasedAutoScalingProperty.builder()
                 .friday(Map.of(
                         "fridayKey", "friday"))
                 .monday(Map.of(
                         "mondayKey", "monday"))
                 .saturday(Map.of(
                         "saturdayKey", "saturday"))
                 .sunday(Map.of(
                         "sundayKey", "sunday"))
                 .thursday(Map.of(
                         "thursdayKey", "thursday"))
                 .tuesday(Map.of(
                         "tuesdayKey", "tuesday"))
                 .wednesday(Map.of(
                         "wednesdayKey", "wednesday"))
                 .build())
         .virtualizationType("virtualizationType")
         .volumes(List.of("volumes"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnInstance.BlockDeviceMappingProperty Example:
static class	CfnInstance.Builder A fluent builder for CfnInstance.
static interface	CfnInstance.EbsBlockDeviceProperty Example:
static interface	CfnInstance.TimeBasedAutoScalingProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnInstance(software.constructs.Construct scope, String id, CfnInstanceProps props) Create a new `AWS::OpsWorks::Instance`.
protected	CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInstance(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAgentVersion() `AWS::OpsWorks::Instance.AgentVersion`.
String	getAmiId() `AWS::OpsWorks::Instance.AmiId`.
String	getArchitecture() `AWS::OpsWorks::Instance.Architecture`.
String	getAttrAvailabilityZone()
String	getAttrPrivateDnsName()
String	getAttrPrivateIp()
String	getAttrPublicDnsName()
String	getAttrPublicIp()
String	getAutoScalingType() `AWS::OpsWorks::Instance.AutoScalingType`.
String	getAvailabilityZone() `AWS::OpsWorks::Instance.AvailabilityZone`.
Object	getBlockDeviceMappings() `AWS::OpsWorks::Instance.BlockDeviceMappings`.
protected Map<String,Object>	getCfnProperties()
Object	getEbsOptimized() `AWS::OpsWorks::Instance.EbsOptimized`.
List<String>	getElasticIps() `AWS::OpsWorks::Instance.ElasticIps`.
String	getHostname() `AWS::OpsWorks::Instance.Hostname`.
Object	getInstallUpdatesOnBoot() `AWS::OpsWorks::Instance.InstallUpdatesOnBoot`.
String	getInstanceType() `AWS::OpsWorks::Instance.InstanceType`.
List<String>	getLayerIds() `AWS::OpsWorks::Instance.LayerIds`.
String	getOs() `AWS::OpsWorks::Instance.Os`.
String	getRootDeviceType() `AWS::OpsWorks::Instance.RootDeviceType`.
String	getSshKeyName() `AWS::OpsWorks::Instance.SshKeyName`.
String	getStackId() `AWS::OpsWorks::Instance.StackId`.
String	getSubnetId() `AWS::OpsWorks::Instance.SubnetId`.
String	getTenancy() `AWS::OpsWorks::Instance.Tenancy`.
Object	getTimeBasedAutoScaling() `AWS::OpsWorks::Instance.TimeBasedAutoScaling`.
String	getVirtualizationType() `AWS::OpsWorks::Instance.VirtualizationType`.
List<String>	getVolumes() `AWS::OpsWorks::Instance.Volumes`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAgentVersion(String value) `AWS::OpsWorks::Instance.AgentVersion`.
void	setAmiId(String value) `AWS::OpsWorks::Instance.AmiId`.
void	setArchitecture(String value) `AWS::OpsWorks::Instance.Architecture`.
void	setAutoScalingType(String value) `AWS::OpsWorks::Instance.AutoScalingType`.
void	setAvailabilityZone(String value) `AWS::OpsWorks::Instance.AvailabilityZone`.
void	setBlockDeviceMappings(IResolvable value) `AWS::OpsWorks::Instance.BlockDeviceMappings`.
void	setBlockDeviceMappings(List<Object> value) `AWS::OpsWorks::Instance.BlockDeviceMappings`.
void	setEbsOptimized(Boolean value) `AWS::OpsWorks::Instance.EbsOptimized`.
void	setEbsOptimized(IResolvable value) `AWS::OpsWorks::Instance.EbsOptimized`.
void	setElasticIps(List<String> value) `AWS::OpsWorks::Instance.ElasticIps`.
void	setHostname(String value) `AWS::OpsWorks::Instance.Hostname`.
void	setInstallUpdatesOnBoot(Boolean value) `AWS::OpsWorks::Instance.InstallUpdatesOnBoot`.
void	setInstallUpdatesOnBoot(IResolvable value) `AWS::OpsWorks::Instance.InstallUpdatesOnBoot`.
void	setInstanceType(String value) `AWS::OpsWorks::Instance.InstanceType`.
void	setLayerIds(List<String> value) `AWS::OpsWorks::Instance.LayerIds`.
void	setOs(String value) `AWS::OpsWorks::Instance.Os`.
void	setRootDeviceType(String value) `AWS::OpsWorks::Instance.RootDeviceType`.
void	setSshKeyName(String value) `AWS::OpsWorks::Instance.SshKeyName`.
void	setStackId(String value) `AWS::OpsWorks::Instance.StackId`.
void	setSubnetId(String value) `AWS::OpsWorks::Instance.SubnetId`.
void	setTenancy(String value) `AWS::OpsWorks::Instance.Tenancy`.
void	setTimeBasedAutoScaling(CfnInstance.TimeBasedAutoScalingProperty value) `AWS::OpsWorks::Instance.TimeBasedAutoScaling`.
void	setTimeBasedAutoScaling(IResolvable value) `AWS::OpsWorks::Instance.TimeBasedAutoScaling`.
void	setVirtualizationType(String value) `AWS::OpsWorks::Instance.VirtualizationType`.
void	setVolumes(List<String> value) `AWS::OpsWorks::Instance.Volumes`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnInstance

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

CfnInstance

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

CfnInstance

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

Create a new `AWS::OpsWorks::Instance`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAgentVersion

@Stability(value=Stable)
 @Nullable
public String getAgentVersion()

`AWS::OpsWorks::Instance.AgentVersion`.

setAgentVersion

@Stability(value=Stable)
public void setAgentVersion(@Nullable
                                                     String value)

`AWS::OpsWorks::Instance.AgentVersion`.

getAmiId

@Stability(value=Stable)
 @Nullable
public String getAmiId()

`AWS::OpsWorks::Instance.AmiId`.

setAmiId

@Stability(value=Stable)
public void setAmiId(@Nullable
                                              String value)

`AWS::OpsWorks::Instance.AmiId`.

getArchitecture

@Stability(value=Stable)
 @Nullable
public String getArchitecture()

`AWS::OpsWorks::Instance.Architecture`.

setArchitecture

@Stability(value=Stable)
public void setArchitecture(@Nullable
                                                     String value)

`AWS::OpsWorks::Instance.Architecture`.

getAttrAvailabilityZone

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

getAttrPrivateDnsName

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

getAttrPrivateIp

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

getAttrPublicDnsName

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

getAttrPublicIp

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

getAutoScalingType

@Stability(value=Stable)
 @Nullable
public String getAutoScalingType()

`AWS::OpsWorks::Instance.AutoScalingType`.

setAutoScalingType

@Stability(value=Stable)
public void setAutoScalingType(@Nullable
                                                        String value)

`AWS::OpsWorks::Instance.AutoScalingType`.

getAvailabilityZone

@Stability(value=Stable)
 @Nullable
public String getAvailabilityZone()

`AWS::OpsWorks::Instance.AvailabilityZone`.

setAvailabilityZone

@Stability(value=Stable)
public void setAvailabilityZone(@Nullable
                                                         String value)

`AWS::OpsWorks::Instance.AvailabilityZone`.

getBlockDeviceMappings

@Stability(value=Stable)
 @Nullable
public Object getBlockDeviceMappings()

`AWS::OpsWorks::Instance.BlockDeviceMappings`.

setBlockDeviceMappings

@Stability(value=Stable)
public void setBlockDeviceMappings(@Nullable
                                                            IResolvable value)

`AWS::OpsWorks::Instance.BlockDeviceMappings`.

setBlockDeviceMappings

@Stability(value=Stable)
public void setBlockDeviceMappings(@Nullable
                                                            List<Object> value)

`AWS::OpsWorks::Instance.BlockDeviceMappings`.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEbsOptimized

@Stability(value=Stable)
 @Nullable
public Object getEbsOptimized()

`AWS::OpsWorks::Instance.EbsOptimized`.

setEbsOptimized

@Stability(value=Stable)
public void setEbsOptimized(@Nullable
                                                     Boolean value)

`AWS::OpsWorks::Instance.EbsOptimized`.

setEbsOptimized

@Stability(value=Stable)
public void setEbsOptimized(@Nullable
                                                     IResolvable value)

`AWS::OpsWorks::Instance.EbsOptimized`.

getElasticIps

@Stability(value=Stable)
 @Nullable
public List<String> getElasticIps()

`AWS::OpsWorks::Instance.ElasticIps`.

setElasticIps

@Stability(value=Stable)
public void setElasticIps(@Nullable
                                                   List<String> value)

`AWS::OpsWorks::Instance.ElasticIps`.

getHostname

@Stability(value=Stable)
 @Nullable
public String getHostname()

`AWS::OpsWorks::Instance.Hostname`.

setHostname

@Stability(value=Stable)
public void setHostname(@Nullable
                                                 String value)

`AWS::OpsWorks::Instance.Hostname`.

getInstallUpdatesOnBoot

@Stability(value=Stable)
 @Nullable
public Object getInstallUpdatesOnBoot()

`AWS::OpsWorks::Instance.InstallUpdatesOnBoot`.

setInstallUpdatesOnBoot

@Stability(value=Stable)
public void setInstallUpdatesOnBoot(@Nullable
                                                             Boolean value)

`AWS::OpsWorks::Instance.InstallUpdatesOnBoot`.

setInstallUpdatesOnBoot

@Stability(value=Stable)
public void setInstallUpdatesOnBoot(@Nullable
                                                             IResolvable value)

`AWS::OpsWorks::Instance.InstallUpdatesOnBoot`.

getInstanceType

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

`AWS::OpsWorks::Instance.InstanceType`.

setInstanceType

@Stability(value=Stable)
public void setInstanceType(@NotNull
                                                     String value)

`AWS::OpsWorks::Instance.InstanceType`.

getLayerIds

@Stability(value=Stable)
 @NotNull
public List<String> getLayerIds()

`AWS::OpsWorks::Instance.LayerIds`.

setLayerIds

@Stability(value=Stable)
public void setLayerIds(@NotNull
                                                 List<String> value)

`AWS::OpsWorks::Instance.LayerIds`.

getOs

@Stability(value=Stable)
 @Nullable
public String getOs()

`AWS::OpsWorks::Instance.Os`.

setOs

@Stability(value=Stable)
public void setOs(@Nullable
                                           String value)

`AWS::OpsWorks::Instance.Os`.

getRootDeviceType

@Stability(value=Stable)
 @Nullable
public String getRootDeviceType()

`AWS::OpsWorks::Instance.RootDeviceType`.

setRootDeviceType

@Stability(value=Stable)
public void setRootDeviceType(@Nullable
                                                       String value)

`AWS::OpsWorks::Instance.RootDeviceType`.

getSshKeyName

@Stability(value=Stable)
 @Nullable
public String getSshKeyName()

`AWS::OpsWorks::Instance.SshKeyName`.

setSshKeyName

@Stability(value=Stable)
public void setSshKeyName(@Nullable
                                                   String value)

`AWS::OpsWorks::Instance.SshKeyName`.

getStackId

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

`AWS::OpsWorks::Instance.StackId`.

setStackId

@Stability(value=Stable)
public void setStackId(@NotNull
                                                String value)

`AWS::OpsWorks::Instance.StackId`.

getSubnetId

@Stability(value=Stable)
 @Nullable
public String getSubnetId()

`AWS::OpsWorks::Instance.SubnetId`.

setSubnetId

@Stability(value=Stable)
public void setSubnetId(@Nullable
                                                 String value)

`AWS::OpsWorks::Instance.SubnetId`.

getTenancy

@Stability(value=Stable)
 @Nullable
public String getTenancy()

`AWS::OpsWorks::Instance.Tenancy`.

setTenancy

@Stability(value=Stable)
public void setTenancy(@Nullable
                                                String value)

`AWS::OpsWorks::Instance.Tenancy`.

getTimeBasedAutoScaling

@Stability(value=Stable)
 @Nullable
public Object getTimeBasedAutoScaling()

`AWS::OpsWorks::Instance.TimeBasedAutoScaling`.

setTimeBasedAutoScaling

@Stability(value=Stable)
public void setTimeBasedAutoScaling(@Nullable
                                                             CfnInstance.TimeBasedAutoScalingProperty value)

`AWS::OpsWorks::Instance.TimeBasedAutoScaling`.

setTimeBasedAutoScaling

@Stability(value=Stable)
public void setTimeBasedAutoScaling(@Nullable
                                                             IResolvable value)

`AWS::OpsWorks::Instance.TimeBasedAutoScaling`.

getVirtualizationType

@Stability(value=Stable)
 @Nullable
public String getVirtualizationType()

`AWS::OpsWorks::Instance.VirtualizationType`.

setVirtualizationType

@Stability(value=Stable)
public void setVirtualizationType(@Nullable
                                                           String value)

`AWS::OpsWorks::Instance.VirtualizationType`.

getVolumes

@Stability(value=Stable)
 @Nullable
public List<String> getVolumes()

`AWS::OpsWorks::Instance.Volumes`.

setVolumes

@Stability(value=Stable)
public void setVolumes(@Nullable
                                                List<String> value)

`AWS::OpsWorks::Instance.Volumes`.