Class CreateLifecyclePolicyRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest
-
- software.amazon.awssdk.services.imagebuilder.model.CreateLifecyclePolicyRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateLifecyclePolicyRequest.Builder,CreateLifecyclePolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLifecyclePolicyRequest extends ImagebuilderRequest implements ToCopyableBuilder<CreateLifecyclePolicyRequest.Builder,CreateLifecyclePolicyRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateLifecyclePolicyRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateLifecyclePolicyRequest.Builderbuilder()StringclientToken()Unique, case-sensitive identifier you provide to ensure idempotency of the request.Stringdescription()Optional description for the lifecycle policy.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexecutionRole()The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasPolicyDetails()For responses, this returns true if the service returned a value for the PolicyDetails property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringname()The name of the lifecycle policy to create.List<LifecyclePolicyDetail>policyDetails()Configuration details for the lifecycle policy rules.LifecyclePolicyResourceSelectionresourceSelection()Selection criteria for the resources that the lifecycle policy applies to.LifecyclePolicyResourceTyperesourceType()The type of Image Builder resource that the lifecycle policy applies to.StringresourceTypeAsString()The type of Image Builder resource that the lifecycle policy applies to.List<SdkField<?>>sdkFields()static Class<? extends CreateLifecyclePolicyRequest.Builder>serializableBuilderClass()LifecyclePolicyStatusstatus()Indicates whether the lifecycle policy resource is enabled.StringstatusAsString()Indicates whether the lifecycle policy resource is enabled.Map<String,String>tags()Tags to apply to the lifecycle policy resource.CreateLifecyclePolicyRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
name
public final String name()
The name of the lifecycle policy to create.
- Returns:
- The name of the lifecycle policy to create.
-
description
public final String description()
Optional description for the lifecycle policy.
- Returns:
- Optional description for the lifecycle policy.
-
status
public final LifecyclePolicyStatus status()
Indicates whether the lifecycle policy resource is enabled.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnLifecyclePolicyStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Indicates whether the lifecycle policy resource is enabled.
- See Also:
LifecyclePolicyStatus
-
statusAsString
public final String statusAsString()
Indicates whether the lifecycle policy resource is enabled.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnLifecyclePolicyStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Indicates whether the lifecycle policy resource is enabled.
- See Also:
LifecyclePolicyStatus
-
executionRole
public final String executionRole()
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.
- Returns:
- The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.
-
resourceType
public final LifecyclePolicyResourceType resourceType()
The type of Image Builder resource that the lifecycle policy applies to.
If the service returns an enum value that is not available in the current SDK version,
resourceTypewill returnLifecyclePolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- The type of Image Builder resource that the lifecycle policy applies to.
- See Also:
LifecyclePolicyResourceType
-
resourceTypeAsString
public final String resourceTypeAsString()
The type of Image Builder resource that the lifecycle policy applies to.
If the service returns an enum value that is not available in the current SDK version,
resourceTypewill returnLifecyclePolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- The type of Image Builder resource that the lifecycle policy applies to.
- See Also:
LifecyclePolicyResourceType
-
hasPolicyDetails
public final boolean hasPolicyDetails()
For responses, this returns true if the service returned a value for the PolicyDetails 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.
-
policyDetails
public final List<LifecyclePolicyDetail> policyDetails()
Configuration details for the lifecycle policy rules.
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
hasPolicyDetails()method.- Returns:
- Configuration details for the lifecycle policy rules.
-
resourceSelection
public final LifecyclePolicyResourceSelection resourceSelection()
Selection criteria for the resources that the lifecycle policy applies to.
- Returns:
- Selection criteria for the resources that the lifecycle policy applies to.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final Map<String,String> tags()
Tags to apply to the lifecycle policy resource.
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
hasTags()method.- Returns:
- Tags to apply to the lifecycle policy resource.
-
clientToken
public final String clientToken()
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- Returns:
- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
-
toBuilder
public CreateLifecyclePolicyRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateLifecyclePolicyRequest.Builder,CreateLifecyclePolicyRequest>- Specified by:
toBuilderin classImagebuilderRequest
-
builder
public static CreateLifecyclePolicyRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateLifecyclePolicyRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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:
getValueForFieldin classSdkRequest
-
-