Interface CfnInstanceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnInstanceProps.Jsii$Proxy
CfnInstance
.
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.*; CfnInstanceProps cfnInstanceProps = CfnInstanceProps.builder() .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();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnInstanceProps
static final class
An implementation forCfnInstanceProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnInstanceProps.Builder
builder()
default String
The default AWS OpsWorks Stacks agent version.default String
getAmiId()
A custom AMI ID to be used to create the instance.default String
The instance architecture.default String
For load-based or time-based instances, the type.default String
The Availability Zone of the AWS OpsWorks instance, such asus-east-2a
.default Object
An array ofBlockDeviceMapping
objects that specify the instance's block devices.default Object
Whether to create an Amazon EBS-optimized instance.A list of Elastic IP addresses to associate with the instance.default String
The instance host name.default Object
Whether to install operating system and package updates when the instance boots.The instance type, such ast2.micro
.An array that contains the instance's layer IDs.default String
getOs()
The instance's operating system, which must be set to one of the following.default String
The instance root device type.default String
The instance's Amazon EC2 key-pair name.The stack ID.default String
The ID of the instance's subnet.default String
The instance's tenancy option.default Object
The time-based scaling configuration for the instance.default String
The instance's virtualization type,paravirtual
orhvm
.A list of AWS OpsWorks volume IDs to associate with the instance.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getInstanceType
The instance type, such ast2.micro
. For a list of supported instance types, open the stack in the console, choose Instances , and choose + Instance . The Size list contains the currently supported types. For more information, see Instance Families and Types . The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.- See Also:
-
getLayerIds
An array that contains the instance's layer IDs.- See Also:
-
getStackId
The stack ID.- See Also:
-
getAgentVersion
The default AWS OpsWorks Stacks agent version. You have the following options:.INHERIT
- Use the stack's default agent version setting.- version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks installs that version on the instance.
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, callDescribeAgentVersions
. AgentVersion cannot be set to Chef 12.2.- See Also:
-
getAmiId
A custom AMI ID to be used to create the instance.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
Os
toCustom
.- See Also:
-
getArchitecture
The instance architecture.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 .- See Also:
-
getAutoScalingType
For load-based or time-based instances, the type.Windows stacks can use only time-based instances.
- See Also:
-
getAvailabilityZone
The Availability Zone of the AWS OpsWorks instance, such asus-east-2a
.- See Also:
-
getBlockDeviceMappings
An array ofBlockDeviceMapping
objects that specify the instance's block devices.For more information, see Block Device Mapping . Note that block device mappings are not supported for custom AMIs.
- See Also:
-
getEbsOptimized
Whether to create an Amazon EBS-optimized instance.- See Also:
-
getElasticIps
A list of Elastic IP addresses to associate with the instance.- See Also:
-
getHostname
The instance host name. The following are character limits for instance host names.- Linux-based instances: 63 characters
- Windows-based instances: 15 characters
- See Also:
-
getInstallUpdatesOnBoot
Whether to install operating system and package updates when the instance boots.The default value is
true
. To control when updates are installed, set this value tofalse
. You must then update your instances manually by usingCreateDeployment
to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
to ensure that your instances have the latest security updates.- See Also:
-
getOs
The instance's operating system, which must be set to one of the following.- A supported Linux operating system: An Amazon Linux version, such as
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
, orAmazon Linux 2015.03
. - A supported Ubuntu operating system, such as
Ubuntu 18.04 LTS
,Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. CentOS Linux 7
Red Hat Enterprise Linux 7
- A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. - A custom AMI:
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 theCreateInstance
action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value isCustom
. For more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs .- See Also:
- A supported Linux operating system: An Amazon Linux version, such as
-
getRootDeviceType
The instance root device type.For more information, see Storage for the Root Device .
- See Also:
-
getSshKeyName
The instance's Amazon EC2 key-pair name.- See Also:
-
getSubnetId
The ID of the instance's subnet.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.
- See Also:
-
getTenancy
The instance's tenancy option.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
, orhost
. 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 .- See Also:
-
getTimeBasedAutoScaling
The time-based scaling configuration for the instance.- See Also:
-
getVirtualizationType
The instance's virtualization type,paravirtual
orhvm
.- See Also:
-
getVolumes
A list of AWS OpsWorks volume IDs to associate with the instance.For more information, see
AWS::OpsWorks::Volume
.- See Also:
-
builder
- Returns:
- a
CfnInstanceProps.Builder
ofCfnInstanceProps
-