Package software.amazon.awscdk.services.imagebuilder.alpha

Class InfrastructureConfigurationProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.imagebuilder.alpha.InfrastructureConfigurationProps.Jsii$Proxy

All Implemented Interfaces:

InfrastructureConfigurationProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

InfrastructureConfigurationProps

@Stability(Experimental)
@Internal
public static final class InfrastructureConfigurationProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements InfrastructureConfigurationProps

An implementation for InfrastructureConfigurationProps

Nested Class Summary

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.imagebuilder.alpha.InfrastructureConfigurationProps

InfrastructureConfigurationProps.Builder, InfrastructureConfigurationProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(InfrastructureConfigurationProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the InfrastructureConfigurationProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getDescription()	(experimental) The description of the infrastructure configuration.
final String	getEc2InstanceAvailabilityZone()	(experimental) The availability zone to place Image Builder build and test EC2 instances.
final String	getEc2InstanceHostId()	(experimental) The ID of the Dedicated Host on which build and test instances run.
final String	getEc2InstanceHostResourceGroupArn()	(experimental) The ARN of the host resource group on which build and test instances run.
final Tenancy	getEc2InstanceTenancy()	(experimental) The tenancy of the instance.
final Number	getHttpPutResponseHopLimit()	(experimental) The maximum number of hops that an instance metadata request can traverse to reach its destination.
final HttpTokens	getHttpTokens()	(experimental) Indicates whether a signed token header is required for instance metadata retrieval requests.
final String	getInfrastructureConfigurationName()	(experimental) The name of the infrastructure configuration.
final IInstanceProfile	getInstanceProfile()	(experimental) The instance profile to associate with the instance used to customize the AMI.
final List<InstanceType>	getInstanceTypes()	(experimental) The instance types to launch build and test EC2 instances with.
final IKeyPair	getKeyPair()	(experimental) The key pair used to connect to the build and test EC2 instances.
final InfrastructureConfigurationLogging	getLogging()	(experimental) The log settings for detailed build logging.
final ITopic	getNotificationTopic()	(experimental) The SNS topic on which notifications are sent when an image build completes.
final Map<String,String>	getResourceTags()	(experimental) The additional tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.
final IRole	getRole()	(experimental) An IAM role to associate with the instance profile used by Image Builder.
final List<ISecurityGroup>	getSecurityGroups()	(experimental) The security groups to associate with the instance used to customize the AMI.
final SubnetSelection	getSubnetSelection()	(experimental) Select which subnet to place the instance used to customize the AMI.
final Map<String,String>	getTags()	(experimental) The tags to apply to the infrastructure configuration.
final Boolean	getTerminateInstanceOnFailure()	(experimental) Whether to terminate the EC2 instance when the build or test workflow fails.
final IVpc	getVpc()	(experimental) The VPC to place the instance used to customize the AMI.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(InfrastructureConfigurationProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the InfrastructureConfigurationProps.Builder.

Method Details

getDescription

public final String getDescription()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The description of the infrastructure configuration.

Default: None

Specified by:

getDescription in interface InfrastructureConfigurationProps

getEc2InstanceAvailabilityZone

public final String getEc2InstanceAvailabilityZone()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The availability zone to place Image Builder build and test EC2 instances.

Default: EC2 will select a random zone

Specified by:

getEc2InstanceAvailabilityZone in interface InfrastructureConfigurationProps

getEc2InstanceHostId

public final String getEc2InstanceHostId()

Description copied from interface: InfrastructureConfigurationProps

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

This only applies if the instance tenancy is host. This cannot be used with the ec2InstanceHostResourceGroupArn parameter.

Default: None

Specified by:

getEc2InstanceHostId in interface InfrastructureConfigurationProps

getEc2InstanceHostResourceGroupArn

public final String getEc2InstanceHostResourceGroupArn()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The ARN of the host resource group on which build and test instances run.

This only applies if the instance tenancy is host. This cannot be used with the ec2InstanceHostId parameter.

Default: None

Specified by:

getEc2InstanceHostResourceGroupArn in interface InfrastructureConfigurationProps

getEc2InstanceTenancy

public final Tenancy getEc2InstanceTenancy()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The tenancy of the instance.

Dedicated tenancy runs instances on single-tenant hardware, while host tenancy runs instances on a dedicated host. Shared tenancy is used by default.

Default: Tenancy.DEFAULT

Specified by:

getEc2InstanceTenancy in interface InfrastructureConfigurationProps

getHttpPutResponseHopLimit

public final Number getHttpPutResponseHopLimit()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The maximum number of hops that an instance metadata request can traverse to reach its destination.

By default, this is set to 2.

Default: 2

Specified by:

getHttpPutResponseHopLimit in interface InfrastructureConfigurationProps

getHttpTokens

public final HttpTokens getHttpTokens()

Description copied from interface: InfrastructureConfigurationProps

(experimental) Indicates whether a signed token header is required for instance metadata retrieval requests.

By default, this is set to required to require IMDSv2 on build and test EC2 instances.

Default: HttpTokens.REQUIRED

Specified by:

getHttpTokens in interface InfrastructureConfigurationProps

getInfrastructureConfigurationName

public final String getInfrastructureConfigurationName()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The name of the infrastructure configuration.

This name must be normalized by transforming all alphabetical characters to lowercase, and replacing all spaces and underscores with hyphens.

Default: A name is generated

Specified by:

getInfrastructureConfigurationName in interface InfrastructureConfigurationProps

getInstanceProfile

public final IInstanceProfile getInstanceProfile()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The instance profile to associate with the instance used to customize the AMI.

By default, an instance profile and role will be created with minimal permissions needed to build the image, attached to the EC2 instance.

If an S3 logging bucket and key prefix is provided, an IAM inline policy will be attached to the instance profile's role, allowing s3:PutObject permissions on the bucket.

Default: An instance profile will be generated

Specified by:

getInstanceProfile in interface InfrastructureConfigurationProps

getInstanceTypes

public final List<InstanceType> getInstanceTypes()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The instance types to launch build and test EC2 instances with.

Default: Image Builder will choose from a default set of instance types compatible with the AMI

Specified by:

getInstanceTypes in interface InfrastructureConfigurationProps

getKeyPair

public final IKeyPair getKeyPair()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The key pair used to connect to the build and test EC2 instances.

The key pair can be used to log into the build or test instances for troubleshooting any failures.

Default: None

Specified by:

getKeyPair in interface InfrastructureConfigurationProps

getLogging

public final InfrastructureConfigurationLogging getLogging()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The log settings for detailed build logging.

Default: None

Specified by:

getLogging in interface InfrastructureConfigurationProps

getNotificationTopic

public final ITopic getNotificationTopic()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The SNS topic on which notifications are sent when an image build completes.

Default: No notifications are sent

Specified by:

getNotificationTopic in interface InfrastructureConfigurationProps

getResourceTags

public final Map<String,String> getResourceTags()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The additional tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.

Default: None

Specified by:

getResourceTags in interface InfrastructureConfigurationProps

getRole

public final IRole getRole()

Description copied from interface: InfrastructureConfigurationProps

(experimental) An IAM role to associate with the instance profile used by Image Builder.

The role must be assumable by the service principal ec2.amazonaws.com: Note: You can provide an instanceProfile or a role, but not both.

Default: A role will automatically be created, it can be accessed via the `role` property

Example:

 Role role = Role.Builder.create(this, "MyRole")
         .assumedBy(new ServicePrincipal("ec2.amazonaws.com"))
         .build();
 

Specified by:

getRole in interface InfrastructureConfigurationProps

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The security groups to associate with the instance used to customize the AMI.

Default: The default security group for the VPC will be used

Specified by:

getSecurityGroups in interface InfrastructureConfigurationProps

getSubnetSelection

public final SubnetSelection getSubnetSelection()

Description copied from interface: InfrastructureConfigurationProps

(experimental) Select which subnet to place the instance used to customize the AMI.

The first subnet that is selected will be used. You must specify the VPC to customize the subnet selection.

Default: The first subnet selected from the provided VPC will be used

Specified by:

getSubnetSelection in interface InfrastructureConfigurationProps

getTags

public final Map<String,String> getTags()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The tags to apply to the infrastructure configuration.

Default: None

Specified by:

getTags in interface InfrastructureConfigurationProps

getTerminateInstanceOnFailure

public final Boolean getTerminateInstanceOnFailure()

Description copied from interface: InfrastructureConfigurationProps

(experimental) Whether to terminate the EC2 instance when the build or test workflow fails.

Default: true

Specified by:

getTerminateInstanceOnFailure in interface InfrastructureConfigurationProps

getVpc

public final IVpc getVpc()

Description copied from interface: InfrastructureConfigurationProps

(experimental) The VPC to place the instance used to customize the AMI.

Default: The default VPC will be used

Specified by:

getVpc in interface InfrastructureConfigurationProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object