Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-aws.Go to Latest
crossplane-contrib/provider-aws@v0.49.1
Instance
ec2.aws.crossplane.io
Instance
crossplane-contrib/provider-aws@v0.49.1ec2.aws.crossplane.io

Instance is a managed resource that represents a specified number of AWS EC2 Instance

Type

CRD

Group

ec2.aws.crossplane.io

Version

v1alpha1

apiVersion: ec2.aws.crossplane.io/v1alpha1

kind: Instance

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

An InstanceSpec defines the desired state of Instances.

forProvider
requiredobject
requiredobject

InstanceParameters define the desired state of the Instances

array

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html) in the Amazon Elastic Compute Cloud User Guide.

type
requiredstring
array

The block device mapping entries.

deviceName
requiredstring
ebs
requiredobject
requiredobject

Parameters used to automatically set up EBS volumes when the instance is launched.

encrypted
boolean
iops
integer
kmsKeyId
string
object

KMSKeyIDRef is a reference to a KMS Key used to set KMSKeyID.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

KMSKeyIDSelector selects a reference to a KMS Key used to set KMSKeyID.

policy
object
object

Policies for selection.

resolve
string
throughput
integer
volumeSize
requiredinteger
noDevice
string
object

Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

object

Information about the target Capacity Reservation.

object

The CPU options for the instance. For more information, see Optimizing CPU Options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the Amazon Elastic Compute Cloud User Guide.

coreCount
requiredinteger
threadsPerCore
requiredinteger
object

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html). For more information, see Burstable Performance Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the Amazon Elastic Compute Cloud User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a instances)

cpuCredits
requiredstring
array

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

count
integer
type
requiredstring
object

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the Amazon Elastic Compute Cloud User Guide.

configured
boolean
object

The IAM instance profile.

arn
string
name
string
imageId
requiredstring
object

The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

marketType
requiredstring
spotOptions
requiredobject
requiredobject

The options for Spot Instances.

array

[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

ipv6Address
requiredstring
kernelId
string
keyName
string
object

The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.

launchTemplateId
requiredstring
launchTemplateName
requiredstring
version
string
array

The Amazon Resource Name (ARN) of the license configuration

object

The metadata options for the instance. For more information, see Instance Metadata and User Data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html).

object

Specifies whether detailed monitoring is enabled for the instance.

enabled
requiredboolean
array

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

deviceIndex
requiredinteger
groups
requiredarray
requiredarray

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

interfaceType
requiredstring
array

One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

ipv6Address
requiredstring
array

One or more IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

ipv6Prefix
requiredstring
array

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request.

primary
boolean
privateIPAddress
requiredstring
subnetId
string
placement
object
object

The placement for the instance.

ramDiskId
string
region
requiredstring
array

The IDs of the security groups. You can create a security group using CreateSecurityGroup (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html).

If you specify a network interface, you must specify any security groups as part of the network interface.

array

SecurityGroupsRefs is a list of references to SecurityGroups used to set the SecurityGroupIDs.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

SecurityGroupsSelector selects references to SecurityGroups used to set the SecurityGroupIDs.

policy
object
object

Policies for selection.

resolve
string
subnetId
string
object

SubnetIDRef is a reference to a Subnet used to set the SubnetID.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

SubnetIDSelector selects a reference to a Subnet used to set the SubnetID.

policy
object
object

Policies for selection.

resolve
string
array

The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).

resourceType
requiredstring
tags
requiredarray
requiredarray

The tags to apply to the resource

key
requiredstring
value
requiredstring
tags
array
array

Tags are used as identification helpers between AWS resources.

key
requiredstring
value
requiredstring
userData
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

An InstanceStatus represents the observed state of Instances.

object

InstanceObservation keeps the state for the external resource. The below fields follow the Instance response object as closely as possible.

architecture
requiredstring
array

No description provided.

deviceName
requiredstring
ebs
requiredobject
requiredobject

Parameters used to automatically set up EBS volumes when the instance is launched.

attachTime
requiredstring
deleteOnTermination
requiredboolean
status
requiredstring
volumeId
requiredstring
object

CapacityReservationSpecificationResponse describes the instance's Capacity Reservation targeting preferences. The action returns the capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation.

object

Information about the targeted Capacity Reservation.

object

CPUOptionsRequest defines the options for the instance. Both the core count and threads per core must be specified in the request.

coreCount
requiredinteger
threadsPerCore
requiredinteger
ebs
string
array

No description provided.

enaSupport
boolean
object

HibernationOptionsRequest indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). For more information, see Hibernate Your Instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the Amazon Elastic Compute Cloud User Guide.

configured
boolean
object

IAMInstanceProfile Describes an IAM instance profile.

arn
requiredstring
id
requiredstring
imageId
string
instanceType
requiredstring
kernelId
string
array

No description provided.

object

InstanceMetadataOptionsRequest defines the metadata options for the instance.

object

Monitoring describes the monitoring of an instance.

state
requiredstring
array

No description provided.

object

The association information for an Elastic IPv4 associated with the network interface.

object

The network interface attachment.

groups
array
array

One or more security groups.

groupId
requiredstring
groupName
requiredstring
array

One or more IPv6 addresses associated with the network interface.

ipv6Address
requiredstring
ownerId
string
array

One or more private IPv4 addresses associated with the network interface.

association
requiredobject
requiredobject

The association information for an Elastic IP address for the network interface.

primary
requiredboolean
privateDnsName
requiredstring
privateIpAddress
requiredstring
status
requiredstring
subnetId
string
vpcId
string
placement
object
object

Placement describes the placement of an instance.

platform
requiredstring
array

No description provided.

productCodeId
requiredstring
productCodeType
requiredstring
ramDiskId
string
rootDeviceType
requiredstring
array

No description provided.

groupId
requiredstring
groupName
requiredstring
state
requiredstring
object

StateReason describes a state change.

code
requiredstring
message
requiredstring
subnetId
string
tags
array
array

No description provided.

key
requiredstring
value
requiredstring
userData
string
virualizationType
requiredstring
vpcId
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.