Class DescribeLaunchTemplateVersionsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeLaunchTemplateVersionsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeLaunchTemplateVersionsRequest.Builder,DescribeLaunchTemplateVersionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeLaunchTemplateVersionsRequest extends Ec2Request implements ToCopyableBuilder<DescribeLaunchTemplateVersionsRequest.Builder,DescribeLaunchTemplateVersionsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeLaunchTemplateVersionsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeLaunchTemplateVersionsRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
One or more filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasVersions()
For responses, this returns true if the service returned a value for the Versions property.String
launchTemplateId()
The ID of the launch template.String
launchTemplateName()
The name of the launch template.Integer
maxResults()
The maximum number of results to return in a single call.String
maxVersion()
The version number up to which to describe launch template versions.String
minVersion()
The version number after which to describe launch template versions.String
nextToken()
The token to request the next page of results.Boolean
resolveAlias()
Iftrue
, and if a Systems Manager parameter is specified forImageId
, the AMI ID is displayed in the response forimageId
.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeLaunchTemplateVersionsRequest.Builder>
serializableBuilderClass()
DescribeLaunchTemplateVersionsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.List<String>
versions()
One or more versions of the launch template.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
launchTemplateId
public final String launchTemplateId()
The ID of the launch template.
To describe one or more versions of a specified launch template, you must specify either the
LaunchTemplateId
or theLaunchTemplateName
, but not both.To describe all the latest or default launch template versions in your account, you must omit this parameter.
- Returns:
- The ID of the launch template.
To describe one or more versions of a specified launch template, you must specify either the
LaunchTemplateId
or theLaunchTemplateName
, but not both.To describe all the latest or default launch template versions in your account, you must omit this parameter.
-
launchTemplateName
public final String launchTemplateName()
The name of the launch template.
To describe one or more versions of a specified launch template, you must specify either the
LaunchTemplateName
or theLaunchTemplateId
, but not both.To describe all the latest or default launch template versions in your account, you must omit this parameter.
- Returns:
- The name of the launch template.
To describe one or more versions of a specified launch template, you must specify either the
LaunchTemplateName
or theLaunchTemplateId
, but not both.To describe all the latest or default launch template versions in your account, you must omit this parameter.
-
hasVersions
public final boolean hasVersions()
For responses, this returns true if the service returned a value for the Versions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
versions
public final List<String> versions()
One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are
$Latest
,$Default
, and numbers.To describe all launch templates in your account that are defined as the latest version, the valid value is
$Latest
. To describe all launch templates in your account that are defined as the default version, the valid value is$Default
. You can specify$Latest
and$Default
in the same request. You cannot specify numbers.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVersions()
method.- Returns:
- One or more versions of the launch template. Valid values depend on whether you are describing a
specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are
$Latest
,$Default
, and numbers.To describe all launch templates in your account that are defined as the latest version, the valid value is
$Latest
. To describe all launch templates in your account that are defined as the default version, the valid value is$Default
. You can specify$Latest
and$Default
in the same request. You cannot specify numbers.
-
minVersion
public final String minVersion()
The version number after which to describe launch template versions.
- Returns:
- The version number after which to describe launch template versions.
-
maxVersion
public final String maxVersion()
The version number up to which to describe launch template versions.
- Returns:
- The version number up to which to describe launch template versions.
-
nextToken
public final String nextToken()
The token to request the next page of results.
- Returns:
- The token to request the next page of results.
-
maxResults
public final Integer maxResults()
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value. This value can be between 1 and 200.- Returns:
- The maximum number of results to return in a single call. To retrieve the remaining results, make another
call with the returned
NextToken
value. This value can be between 1 and 200.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
filters
public final List<Filter> filters()
One or more filters.
-
create-time
- The time the launch template version was created. -
ebs-optimized
- A boolean that indicates whether the instance is optimized for Amazon EBS I/O. -
http-endpoint
- Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled
|disabled
). -
http-protocol-ipv4
- Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled
|disabled
). -
host-resource-group-arn
- The ARN of the host resource group in which to launch the instances. -
http-tokens
- The state of token usage for your instance metadata requests (optional
|required
). -
iam-instance-profile
- The ARN of the IAM instance profile. -
image-id
- The ID of the AMI. -
instance-type
- The instance type. -
is-default-version
- A boolean that indicates whether the launch template version is the default version. -
kernel-id
- The kernel ID. -
license-configuration-arn
- The ARN of the license configuration. -
network-card-index
- The index of the network card. -
ram-disk-id
- The RAM disk ID.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- Returns:
- One or more filters.
-
create-time
- The time the launch template version was created. -
ebs-optimized
- A boolean that indicates whether the instance is optimized for Amazon EBS I/O. -
http-endpoint
- Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled
|disabled
). -
http-protocol-ipv4
- Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled
|disabled
). -
host-resource-group-arn
- The ARN of the host resource group in which to launch the instances. -
http-tokens
- The state of token usage for your instance metadata requests (optional
|required
). -
iam-instance-profile
- The ARN of the IAM instance profile. -
image-id
- The ID of the AMI. -
instance-type
- The instance type. -
is-default-version
- A boolean that indicates whether the launch template version is the default version. -
kernel-id
- The kernel ID. -
license-configuration-arn
- The ARN of the license configuration. -
network-card-index
- The index of the network card. -
ram-disk-id
- The RAM disk ID.
-
-
-
resolveAlias
public final Boolean resolveAlias()
If
true
, and if a Systems Manager parameter is specified forImageId
, the AMI ID is displayed in the response forimageId
.If
false
, and if a Systems Manager parameter is specified forImageId
, the parameter is displayed in the response forimageId
.For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
Default:
false
- Returns:
- If
true
, and if a Systems Manager parameter is specified forImageId
, the AMI ID is displayed in the response forimageId
.If
false
, and if a Systems Manager parameter is specified forImageId
, the parameter is displayed in the response forimageId
.For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
Default:
false
-
toBuilder
public DescribeLaunchTemplateVersionsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeLaunchTemplateVersionsRequest.Builder,DescribeLaunchTemplateVersionsRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeLaunchTemplateVersionsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeLaunchTemplateVersionsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-