Class: Aws::S3::Types::HeadBucketOutput

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_point_aliasBoolean

Indicates whether the bucket name used in the request is an access point alias.

<note markdown=“1”> For directory buckets, the value of this field is false.

</note>

Returns:

  • (Boolean)


9208
9209
9210
9211
9212
9213
9214
9215
9216
# File 'lib/aws-sdk-s3/types.rb', line 9208

class HeadBucketOutput < Struct.new(
  :bucket_arn,
  :bucket_location_type,
  :bucket_location_name,
  :bucket_region,
  :access_point_alias)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_arnString

The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.

<note markdown=“1”> This parameter is only supported for S3 directory buckets. For more information, see [Using tags with directory buckets].

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html

Returns:

  • (String)


9208
9209
9210
9211
9212
9213
9214
9215
9216
# File 'lib/aws-sdk-s3/types.rb', line 9208

class HeadBucketOutput < Struct.new(
  :bucket_arn,
  :bucket_location_type,
  :bucket_location_name,
  :bucket_region,
  :access_point_alias)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_location_nameString

The name of the location where the bucket will be created.

For directory buckets, the Zone ID of the Availability Zone or the Local Zone where the bucket is created. An example Zone ID value for an Availability Zone is usw2-az1.

<note markdown=“1”> This functionality is only supported by directory buckets.

</note>

Returns:

  • (String)


9208
9209
9210
9211
9212
9213
9214
9215
9216
# File 'lib/aws-sdk-s3/types.rb', line 9208

class HeadBucketOutput < Struct.new(
  :bucket_arn,
  :bucket_location_type,
  :bucket_location_name,
  :bucket_region,
  :access_point_alias)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_location_typeString

The type of location where the bucket is created.

<note markdown=“1”> This functionality is only supported by directory buckets.

</note>

Returns:

  • (String)


9208
9209
9210
9211
9212
9213
9214
9215
9216
# File 'lib/aws-sdk-s3/types.rb', line 9208

class HeadBucketOutput < Struct.new(
  :bucket_arn,
  :bucket_location_type,
  :bucket_location_name,
  :bucket_region,
  :access_point_alias)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_regionString

The Region that the bucket is located.

Returns:

  • (String)


9208
9209
9210
9211
9212
9213
9214
9215
9216
# File 'lib/aws-sdk-s3/types.rb', line 9208

class HeadBucketOutput < Struct.new(
  :bucket_arn,
  :bucket_location_type,
  :bucket_location_name,
  :bucket_region,
  :access_point_alias)
  SENSITIVE = []
  include Aws::Structure
end