Package software.amazon.awscdk.services.imagebuilder

Interface CfnInfrastructureConfiguration.PlacementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInfrastructureConfiguration.PlacementProperty.Jsii$Proxy

Enclosing class:

CfnInfrastructureConfiguration

@Stability(Stable)
public static interface CfnInfrastructureConfiguration.PlacementProperty
extends software.amazon.jsii.JsiiSerializable

By default, EC2 instances run on shared tenancy hardware.

This means that multiple AWS accounts might share the same physical hardware. When you use dedicated hardware, the physical server that hosts your instances is dedicated to your AWS account . Instance placement settings contain the details for the physical hardware where instances that Image Builder launches during image creation will run.

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.imagebuilder.*;
 PlacementProperty placementProperty = PlacementProperty.builder()
         .availabilityZone("availabilityZone")
         .hostId("hostId")
         .hostResourceGroupArn("hostResourceGroupArn")
         .tenancy("tenancy")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInfrastructureConfiguration.PlacementProperty.Builder	A builder for CfnInfrastructureConfiguration.PlacementProperty
static final class	CfnInfrastructureConfiguration.PlacementProperty.Jsii$Proxy	An implementation for CfnInfrastructureConfiguration.PlacementProperty

Method Summary

Modifier and Type	Method	Description
static CfnInfrastructureConfiguration.PlacementProperty.Builder	builder()
default String	getAvailabilityZone()	The Availability Zone where your build and test instances will launch.
default String	getHostId()	The ID of the Dedicated Host on which build and test instances run.
default String	getHostResourceGroupArn()	The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances.
default String	getTenancy()	The tenancy of the instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityZone

@Stability(Stable)
@Nullable
default String getAvailabilityZone()

The Availability Zone where your build and test instances will launch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html#cfn-imagebuilder-infrastructureconfiguration-placement-availabilityzone

getHostId

@Stability(Stable)
@Nullable
default String getHostId()

The ID of the Dedicated Host on which build and test instances run.

This only applies if tenancy is host . If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html#cfn-imagebuilder-infrastructureconfiguration-placement-hostid

getHostResourceGroupArn

@Stability(Stable)
@Nullable
default String getHostResourceGroupArn()

The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances.

This only applies if tenancy is host . If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html#cfn-imagebuilder-infrastructureconfiguration-placement-hostresourcegrouparn

getTenancy

@Stability(Stable)
@Nullable
default String getTenancy()

The tenancy of the instance.

An instance with a tenancy of dedicated runs on single-tenant hardware. An instance with a tenancy of host runs on a Dedicated Host.

If tenancy is set to host , then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html#cfn-imagebuilder-infrastructureconfiguration-placement-tenancy

builder

@Stability(Stable)
static CfnInfrastructureConfiguration.PlacementProperty.Builder builder()

Returns:

a CfnInfrastructureConfiguration.PlacementProperty.Builder of CfnInfrastructureConfiguration.PlacementProperty