Class CreateDistributionRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.lightsail.model.LightsailRequest
-
- software.amazon.awssdk.services.lightsail.model.CreateDistributionRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateDistributionRequest.Builder,CreateDistributionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDistributionRequest extends LightsailRequest implements ToCopyableBuilder<CreateDistributionRequest.Builder,CreateDistributionRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateDistributionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateDistributionRequest.Builderbuilder()StringbundleId()The bundle ID to use for the distribution.List<CacheBehaviorPerPath>cacheBehaviors()An array of objects that describe the per-path cache behavior for the distribution.CacheSettingscacheBehaviorSettings()An object that describes the cache behavior settings for the distribution.CacheBehaviordefaultCacheBehavior()An object that describes the default cache behavior for the distribution.StringdistributionName()The name for the distribution.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCacheBehaviors()For responses, this returns true if the service returned a value for the CacheBehaviors property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.IpAddressTypeipAddressType()The IP address type for the distribution.StringipAddressTypeAsString()The IP address type for the distribution.InputOriginorigin()An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.List<SdkField<?>>sdkFields()static Class<? extends CreateDistributionRequest.Builder>serializableBuilderClass()List<Tag>tags()The tag keys and optional values to add to the distribution during create.CreateDistributionRequest.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
-
distributionName
public final String distributionName()
The name for the distribution.
- Returns:
- The name for the distribution.
-
origin
public final InputOrigin origin()
An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
- Returns:
- An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket,
or load balancer.
The distribution pulls, caches, and serves content from the origin.
-
defaultCacheBehavior
public final CacheBehavior defaultCacheBehavior()
An object that describes the default cache behavior for the distribution.
- Returns:
- An object that describes the default cache behavior for the distribution.
-
cacheBehaviorSettings
public final CacheSettings cacheBehaviorSettings()
An object that describes the cache behavior settings for the distribution.
- Returns:
- An object that describes the cache behavior settings for the distribution.
-
hasCacheBehaviors
public final boolean hasCacheBehaviors()
For responses, this returns true if the service returned a value for the CacheBehaviors 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.
-
cacheBehaviors
public final List<CacheBehaviorPerPath> cacheBehaviors()
An array of objects that describe the per-path cache behavior for the distribution.
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
hasCacheBehaviors()method.- Returns:
- An array of objects that describe the per-path cache behavior for the distribution.
-
bundleId
public final String bundleId()
The bundle ID to use for the distribution.
A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.
Use the
GetDistributionBundlesaction to get a list of distribution bundle IDs that you can specify.- Returns:
- The bundle ID to use for the distribution.
A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.
Use the
GetDistributionBundlesaction to get a list of distribution bundle IDs that you can specify.
-
ipAddressType
public final IpAddressType ipAddressType()
The IP address type for the distribution.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack.If the service returns an enum value that is not available in the current SDK version,
ipAddressTypewill returnIpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromipAddressTypeAsString().- Returns:
- The IP address type for the distribution.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack. - See Also:
IpAddressType
-
ipAddressTypeAsString
public final String ipAddressTypeAsString()
The IP address type for the distribution.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack.If the service returns an enum value that is not available in the current SDK version,
ipAddressTypewill returnIpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromipAddressTypeAsString().- Returns:
- The IP address type for the distribution.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack. - See Also:
IpAddressType
-
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 List<Tag> tags()
The tag keys and optional values to add to the distribution during create.
Use the
TagResourceaction to tag a resource after it's created.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:
- The tag keys and optional values to add to the distribution during create.
Use the
TagResourceaction to tag a resource after it's created.
-
toBuilder
public CreateDistributionRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateDistributionRequest.Builder,CreateDistributionRequest>- Specified by:
toBuilderin classLightsailRequest
-
builder
public static CreateDistributionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDistributionRequest.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
-
-