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>

  • Method Details

    • 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 the isEmpty() 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 GetDistributionBundles action 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 GetDistributionBundles action 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 ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

      The default value is dualstack.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The IP address type for the distribution.

      The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

      The default value is dualstack.

      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The IP address type for the distribution.

      The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

      The default value is dualstack.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The IP address type for the distribution.

      The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

      The default value is dualstack.

      See Also:

    • 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 the isEmpty() 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 TagResource action 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 TagResource action to tag a resource after it's created.

    • certificateName

      public final String certificateName()

      The name of the SSL/TLS certificate that you want to attach to the distribution.

      Use the GetCertificates action to get a list of certificate names that you can specify.

      Returns:
      The name of the SSL/TLS certificate that you want to attach to the distribution.

      Use the GetCertificates action to get a list of certificate names that you can specify.

    • viewerMinimumTlsProtocolVersion

      public final ViewerMinimumTlsProtocolVersionEnum viewerMinimumTlsProtocolVersion()

      The minimum TLS protocol version for the SSL/TLS certificate.

      If the service returns an enum value that is not available in the current SDK version, viewerMinimumTlsProtocolVersion will return ViewerMinimumTlsProtocolVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from viewerMinimumTlsProtocolVersionAsString().

      Returns:
      The minimum TLS protocol version for the SSL/TLS certificate.
      See Also:

    • viewerMinimumTlsProtocolVersionAsString

      public final String viewerMinimumTlsProtocolVersionAsString()

      The minimum TLS protocol version for the SSL/TLS certificate.

      If the service returns an enum value that is not available in the current SDK version, viewerMinimumTlsProtocolVersion will return ViewerMinimumTlsProtocolVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from viewerMinimumTlsProtocolVersionAsString().

      Returns:
      The minimum TLS protocol version for the SSL/TLS certificate.
      See Also:

    • toBuilder

      public CreateDistributionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDistributionRequest.Builder,CreateDistributionRequest>
      Specified by:
      toBuilder in class LightsailRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDistributionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDistributionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.