Class Bucket

java.lang.Object
software.amazon.awssdk.services.lightsail.model.Bucket
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Bucket.Builder,Bucket>
@Generated("software.amazon.awssdk:codegen") public final class Bucket extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Bucket.Builder,Bucket>

Describes an Amazon Lightsail bucket.

See Also:

  • Method Details

    • resourceType

      public final String resourceType()

      The Lightsail resource type of the bucket.

      Returns:
      The Lightsail resource type of the bucket.

    • accessRules

      public final AccessRules accessRules()

      An object that describes the access rules of the bucket.

      Returns:
      An object that describes the access rules of the bucket.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the bucket.

      Returns:
      The Amazon Resource Name (ARN) of the bucket.

    • bundleId

      public final String bundleId()

      The ID of the bundle currently applied to the bucket.

      A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

      Use the UpdateBucketBundle action to change the bundle of a bucket.

      Returns:
      The ID of the bundle currently applied to the bucket.

      A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

      Use the UpdateBucketBundle action to change the bundle of a bucket.

    • createdAt

      public final Instant createdAt()

      The timestamp when the distribution was created.

      Returns:
      The timestamp when the distribution was created.

    • url

      public final String url()

      The URL of the bucket.

      Returns:
      The URL of the bucket.

    • location

      public final ResourceLocation location()

      An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

      Returns:
      An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

    • name

      public final String name()

      The name of the bucket.

      Returns:
      The name of the bucket.

    • supportCode

      public final String supportCode()

      The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

      Returns:
      The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

    • 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 for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

      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 for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

    • objectVersioning

      public final String objectVersioning()

      Indicates whether object versioning is enabled for the bucket.

      The following options can be configured:

      • Enabled - Object versioning is enabled.

      • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

      • NeverEnabled - Object versioning has never been enabled.

      Returns:
      Indicates whether object versioning is enabled for the bucket.

      The following options can be configured:

      • Enabled - Object versioning is enabled.

      • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

      • NeverEnabled - Object versioning has never been enabled.

    • ableToUpdateBundle

      public final Boolean ableToUpdateBundle()

      Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

      You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.

      Use the UpdateBucketBundle action to change a bucket's bundle.

      Returns:
      Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

      You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.

      Use the UpdateBucketBundle action to change a bucket's bundle.

    • hasReadonlyAccessAccounts

      public final boolean hasReadonlyAccessAccounts()
      For responses, this returns true if the service returned a value for the ReadonlyAccessAccounts 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.

    • readonlyAccessAccounts

      public final List<String> readonlyAccessAccounts()

      An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

      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 hasReadonlyAccessAccounts() method.

      Returns:
      An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

    • hasResourcesReceivingAccess

      public final boolean hasResourcesReceivingAccess()
      For responses, this returns true if the service returned a value for the ResourcesReceivingAccess 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.

    • resourcesReceivingAccess

      public final List<ResourceReceivingAccess> resourcesReceivingAccess()

      An array of objects that describe Lightsail instances that have access to the bucket.

      Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

      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 hasResourcesReceivingAccess() method.

      Returns:
      An array of objects that describe Lightsail instances that have access to the bucket.

      Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

    • state

      public final BucketState state()

      An object that describes the state of the bucket.

      Returns:
      An object that describes the state of the bucket.

    • accessLogConfig

      public final BucketAccessLogConfig accessLogConfig()

      An object that describes the access log configuration for the bucket.

      Returns:
      An object that describes the access log configuration for the bucket.

    • toBuilder

      public Bucket.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<Bucket.Builder,Bucket>
      Returns:
      a builder for type T

    • builder

      public static Bucket.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.