@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:41.116Z") @Stability(value=Stable) public class CfnInstance extends CfnResource implements IInspectable
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
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();
| Modifier and Type | Class and Description |
|---|---|
static interface |
CfnInstance.BlockDeviceMappingProperty
Describes a block device mapping.
|
static class |
CfnInstance.Builder
A fluent builder for
CfnInstance. |
static interface |
CfnInstance.EbsBlockDeviceProperty
Describes an Amazon EBS volume.
|
static interface |
CfnInstance.TimeBasedAutoScalingProperty
Describes an instance's time-based auto scaling configuration.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| 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) |
| Modifier and Type | Method and Description |
|---|---|
String |
getAgentVersion()
The default AWS OpsWorks Stacks agent version.
|
String |
getAmiId()
A custom AMI ID to be used to create the instance.
|
String |
getArchitecture()
The instance architecture.
|
String |
getAttrAvailabilityZone()
The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` .
|
String |
getAttrPrivateDnsName()
The private DNS name of the AWS OpsWorks instance.
|
String |
getAttrPrivateIp()
The private IP address of the AWS OpsWorks instance, such as `192.0.2.0` .
|
String |
getAttrPublicDnsName()
The public DNS name of the AWS OpsWorks instance.
|
String |
getAttrPublicIp()
The public IP address of the AWS OpsWorks instance, such as `192.0.2.0` .
|
String |
getAutoScalingType()
For load-based or time-based instances, the type.
|
String |
getAvailabilityZone()
The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` .
|
Object |
getBlockDeviceMappings()
An array of `BlockDeviceMapping` objects that specify the instance's block devices.
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getEbsOptimized()
Whether to create an Amazon EBS-optimized instance.
|
List<String> |
getElasticIps()
A list of Elastic IP addresses to associate with the instance.
|
String |
getHostname()
The instance host name.
|
Object |
getInstallUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots.
|
String |
getInstanceType()
The instance type, such as `t2.micro` .
|
List<String> |
getLayerIds()
An array that contains the instance's layer IDs.
|
String |
getOs()
The instance's operating system, which must be set to one of the following.
|
String |
getRootDeviceType()
The instance root device type.
|
String |
getSshKeyName()
The instance's Amazon EC2 key-pair name.
|
String |
getStackId()
The stack ID.
|
String |
getSubnetId()
The ID of the instance's subnet.
|
String |
getTenancy()
The instance's tenancy option.
|
Object |
getTimeBasedAutoScaling()
The time-based scaling configuration for the instance.
|
String |
getVirtualizationType()
The instance's virtualization type, `paravirtual` or `hvm` .
|
List<String> |
getVolumes()
A list of AWS OpsWorks volume IDs to associate with the instance.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAgentVersion(String value)
The default AWS OpsWorks Stacks agent version.
|
void |
setAmiId(String value)
A custom AMI ID to be used to create the instance.
|
void |
setArchitecture(String value)
The instance architecture.
|
void |
setAutoScalingType(String value)
For load-based or time-based instances, the type.
|
void |
setAvailabilityZone(String value)
The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` .
|
void |
setBlockDeviceMappings(IResolvable value)
An array of `BlockDeviceMapping` objects that specify the instance's block devices.
|
void |
setBlockDeviceMappings(List<Object> value)
An array of `BlockDeviceMapping` objects that specify the instance's block devices.
|
void |
setEbsOptimized(Boolean value)
Whether to create an Amazon EBS-optimized instance.
|
void |
setEbsOptimized(IResolvable value)
Whether to create an Amazon EBS-optimized instance.
|
void |
setElasticIps(List<String> value)
A list of Elastic IP addresses to associate with the instance.
|
void |
setHostname(String value)
The instance host name.
|
void |
setInstallUpdatesOnBoot(Boolean value)
Whether to install operating system and package updates when the instance boots.
|
void |
setInstallUpdatesOnBoot(IResolvable value)
Whether to install operating system and package updates when the instance boots.
|
void |
setInstanceType(String value)
The instance type, such as `t2.micro` .
|
void |
setLayerIds(List<String> value)
An array that contains the instance's layer IDs.
|
void |
setOs(String value)
The instance's operating system, which must be set to one of the following.
|
void |
setRootDeviceType(String value)
The instance root device type.
|
void |
setSshKeyName(String value)
The instance's Amazon EC2 key-pair name.
|
void |
setStackId(String value)
The stack ID.
|
void |
setSubnetId(String value)
The ID of the instance's subnet.
|
void |
setTenancy(String value)
The instance's tenancy option.
|
void |
setTimeBasedAutoScaling(CfnInstance.TimeBasedAutoScalingProperty value)
The time-based scaling configuration for the instance.
|
void |
setTimeBasedAutoScaling(IResolvable value)
The time-based scaling configuration for the instance.
|
void |
setVirtualizationType(String value)
The instance's virtualization type, `paravirtual` or `hvm` .
|
void |
setVolumes(List<String> value)
A list of AWS OpsWorks volume IDs to associate with the instance.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnInstance(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnInstance(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnInstanceProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrAvailabilityZone()
@Stability(value=Stable) @NotNull public String getAttrPrivateDnsName()
@Stability(value=Stable) @NotNull public String getAttrPrivateIp()
@Stability(value=Stable) @NotNull public String getAttrPublicDnsName()
@Stability(value=Stable) @NotNull public String getAttrPublicIp()
Use this attribute only when the AWS OpsWorks instance is in an AWS OpsWorks layer that auto-assigns public IP addresses.
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public String getInstanceType()
@Stability(value=Stable)
public void setInstanceType(@NotNull
String value)
@Stability(value=Stable) @NotNull public List<String> getLayerIds()
@Stability(value=Stable)
public void setLayerIds(@NotNull
List<String> value)
@Stability(value=Stable) @NotNull public String getStackId()
@Stability(value=Stable)
public void setStackId(@NotNull
String value)
@Stability(value=Stable) @Nullable public String getAgentVersion()
INHERIT - Use the stack's default agent version setting.
The default setting is INHERIT . To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions . AgentVersion cannot be set to Chef 12.2.
@Stability(value=Stable)
public void setAgentVersion(@Nullable
String value)
INHERIT - Use the stack's default agent version setting.
The default setting is INHERIT . To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions . AgentVersion cannot be set to Chef 12.2.
@Stability(value=Stable) @Nullable public String getAmiId()
The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs .
If you specify a custom AMI, you must set
OstoCustom.
@Stability(value=Stable)
public void setAmiId(@Nullable
String value)
The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs .
If you specify a custom AMI, you must set
OstoCustom.
@Stability(value=Stable) @Nullable public String getArchitecture()
The default option is x86_64 . Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types .
@Stability(value=Stable)
public void setArchitecture(@Nullable
String value)
The default option is x86_64 . Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types .
@Stability(value=Stable) @Nullable public String getAutoScalingType()
Windows stacks can use only time-based instances.
@Stability(value=Stable)
public void setAutoScalingType(@Nullable
String value)
Windows stacks can use only time-based instances.
@Stability(value=Stable) @Nullable public String getAvailabilityZone()
@Stability(value=Stable)
public void setAvailabilityZone(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getBlockDeviceMappings()
For more information, see Block Device Mapping . Note that block device mappings are not supported for custom AMIs.
@Stability(value=Stable)
public void setBlockDeviceMappings(@Nullable
IResolvable value)
For more information, see Block Device Mapping . Note that block device mappings are not supported for custom AMIs.
@Stability(value=Stable)
public void setBlockDeviceMappings(@Nullable
List<Object> value)
For more information, see Block Device Mapping . Note that block device mappings are not supported for custom AMIs.
@Stability(value=Stable) @Nullable public Object getEbsOptimized()
@Stability(value=Stable)
public void setEbsOptimized(@Nullable
Boolean value)
@Stability(value=Stable)
public void setEbsOptimized(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public List<String> getElasticIps()
@Stability(value=Stable)
public void setElasticIps(@Nullable
List<String> value)
@Stability(value=Stable) @Nullable public String getHostname()
@Stability(value=Stable)
public void setHostname(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getInstallUpdatesOnBoot()
The default value is true . To control when updates are installed, set this value to false . You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of
trueto ensure that your instances have the latest security updates.
@Stability(value=Stable)
public void setInstallUpdatesOnBoot(@Nullable
Boolean value)
The default value is true . To control when updates are installed, set this value to false . You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of
trueto ensure that your instances have the latest security updates.
@Stability(value=Stable)
public void setInstallUpdatesOnBoot(@Nullable
IResolvable value)
The default value is true . To control when updates are installed, set this value to false . You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of
trueto ensure that your instances have the latest security updates.
@Stability(value=Stable) @Nullable public String getOs()
Amazon Linux 2 , Amazon Linux 2018.03 , Amazon Linux 2017.09 , Amazon Linux 2017.03 , Amazon Linux 2016.09 , Amazon Linux 2016.03 , Amazon Linux 2015.09 , or Amazon Linux 2015.03 .Ubuntu 18.04 LTS , Ubuntu 16.04 LTS , Ubuntu 14.04 LTS , or Ubuntu 12.04 LTS .CentOS Linux 7Red Hat Enterprise Linux 7Microsoft Windows Server 2012 R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft Windows Server 2012 R2 with SQL Server Web .Custom .Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems .
The default option is the current Amazon Linux version. If you set this parameter to Custom , you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom . For more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs .
@Stability(value=Stable)
public void setOs(@Nullable
String value)
Amazon Linux 2 , Amazon Linux 2018.03 , Amazon Linux 2017.09 , Amazon Linux 2017.03 , Amazon Linux 2016.09 , Amazon Linux 2016.03 , Amazon Linux 2015.09 , or Amazon Linux 2015.03 .Ubuntu 18.04 LTS , Ubuntu 16.04 LTS , Ubuntu 14.04 LTS , or Ubuntu 12.04 LTS .CentOS Linux 7Red Hat Enterprise Linux 7Microsoft Windows Server 2012 R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft Windows Server 2012 R2 with SQL Server Web .Custom .Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems .
The default option is the current Amazon Linux version. If you set this parameter to Custom , you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom . For more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs .
@Stability(value=Stable) @Nullable public String getRootDeviceType()
For more information, see Storage for the Root Device .
@Stability(value=Stable)
public void setRootDeviceType(@Nullable
String value)
For more information, see Storage for the Root Device .
@Stability(value=Stable) @Nullable public String getSshKeyName()
@Stability(value=Stable)
public void setSshKeyName(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getSubnetId()
If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.
@Stability(value=Stable)
public void setSubnetId(@Nullable
String value)
If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.
@Stability(value=Stable) @Nullable public String getTenancy()
The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated , default , or host . Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts . For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances .
@Stability(value=Stable)
public void setTenancy(@Nullable
String value)
The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated , default , or host . Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts . For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances .
@Stability(value=Stable) @Nullable public Object getTimeBasedAutoScaling()
@Stability(value=Stable)
public void setTimeBasedAutoScaling(@Nullable
CfnInstance.TimeBasedAutoScalingProperty value)
@Stability(value=Stable)
public void setTimeBasedAutoScaling(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getVirtualizationType()
@Stability(value=Stable)
public void setVirtualizationType(@Nullable
String value)
@Stability(value=Stable) @Nullable public List<String> getVolumes()
For more information, see AWS::OpsWorks::Volume .
@Stability(value=Stable)
public void setVolumes(@Nullable
List<String> value)
For more information, see AWS::OpsWorks::Volume .
Copyright © 2022. All rights reserved.