Class: AWSCDK::S3Express::CfnDirectoryBucket

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSS3Express::IDirectoryBucketRef
Defined in:
s3_express/cfn_directory_bucket.rb

Overview

The AWS::S3Express::DirectoryBucket resource defines an Amazon S3 directory bucket in the same AWS Region where you create the AWS CloudFormation stack.

To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to retain the bucket or to delete the bucket. For more information, see DeletionPolicy attribute .

You can only delete empty buckets. Deletion fails for buckets that have contents.

  • Permissions - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
  • Create
  • s3express:CreateBucket
  • s3express:ListAllMyDirectoryBuckets
  • Read
  • s3express:ListAllMyDirectoryBuckets
  • ec2:DescribeAvailabilityZones
  • Delete
  • s3express:DeleteBucket
  • s3express:ListAllMyDirectoryBuckets
  • List
  • s3express:ListAllMyDirectoryBuckets
  • PutBucketEncryption
  • s3express:PutEncryptionConfiguration
  • To set a directory bucket default encryption with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and AWS KMS key policies for the target AWS KMS key.
  • GetBucketEncryption
  • s3express:GetBucketEncryption
  • DeleteBucketEncryption
  • s3express:PutEncryptionConfiguration

The following operations are related to AWS::S3Express::DirectoryBucket :

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDirectoryBucket

Create a new AWS::S3Express::DirectoryBucket.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::S3Express::CfnDirectoryBucketProps) —

    Resource properties.



48
49
50
51
52
53
54
 
# File 's3_express/cfn_directory_bucket.rb', line 48

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::S3Express::CfnDirectoryBucketProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczNleHByZXNzLkNmbkRpcmVjdG9yeUJ1Y2tldFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_directory_bucket(resource) ⇒ String

Parameters:

Returns:

  • (String) 


110
111
112
113
 
# File 's3_express/cfn_directory_bucket.rb', line 110

def self.arn_for_directory_bucket(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zM2V4cHJlc3MuSURpcmVjdG9yeUJ1Y2tldFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3express.CfnDirectoryBucket", "arnForDirectoryBucket", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


243
244
245
 
# File 's3_express/cfn_directory_bucket.rb', line 243

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_s3express.CfnDirectoryBucket", "CFN_RESOURCE_TYPE_NAME")
end

.from_bucket_name(scope, id, bucket_name) ⇒ AWSCDK::Interfaces::AWSS3Express::IDirectoryBucketRef

Creates a new IDirectoryBucketRef from a bucketName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • bucket_name (String)

Returns:



121
122
123
124
125
126
 
# File 's3_express/cfn_directory_bucket.rb', line 121

def self.from_bucket_name(scope, id, bucket_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3express.CfnDirectoryBucket", "fromBucketName", [scope, id, bucket_name])
end

.from_directory_bucket_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSS3Express::IDirectoryBucketRef

Creates a new IDirectoryBucketRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



134
135
136
137
138
139
 
# File 's3_express/cfn_directory_bucket.rb', line 134

def self.from_directory_bucket_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3express.CfnDirectoryBucket", "fromDirectoryBucketArn", [scope, id, arn])
end

.is_cfn_directory_bucket(x) ⇒ Boolean

Checks whether the given object is a CfnDirectoryBucket.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


145
146
147
148
 
# File 's3_express/cfn_directory_bucket.rb', line 145

def self.is_cfn_directory_bucket(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3express.CfnDirectoryBucket", "isCfnDirectoryBucket", [x])
end

.jsii_overridable_methods ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 's3_express/cfn_directory_bucket.rb', line 56

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_availability_zone_name => { kind: :property, name: "attrAvailabilityZoneName", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :directory_bucket_ref => { kind: :property, name: "directoryBucketRef", is_optional: false },
    :data_redundancy => { kind: :property, name: "dataRedundancy", is_optional: false },
    :location_name => { kind: :property, name: "locationName", is_optional: false },
    :bucket_encryption => { kind: :property, name: "bucketEncryption", is_optional: true },
    :bucket_name => { kind: :property, name: "bucketName", is_optional: true },
    :inventory_configurations => { kind: :property, name: "inventoryConfigurations", is_optional: true },
    :lifecycle_configuration => { kind: :property, name: "lifecycleConfiguration", is_optional: true },
    :metrics_configurations => { kind: :property, name: "metricsConfigurations", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



418
419
420
421
 
# File 's3_express/cfn_directory_bucket.rb', line 418

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



430
431
432
433
 
# File 's3_express/cfn_directory_bucket.rb', line 430

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



440
441
442
443
 
# File 's3_express/cfn_directory_bucket.rb', line 440

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



451
452
453
454
455
 
# File 's3_express/cfn_directory_bucket.rb', line 451

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


508
509
510
511
512
 
# File 's3_express/cfn_directory_bucket.rb', line 508

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



518
519
520
521
 
# File 's3_express/cfn_directory_bucket.rb', line 518

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



530
531
532
533
534
 
# File 's3_express/cfn_directory_bucket.rb', line 530

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



543
544
545
546
 
# File 's3_express/cfn_directory_bucket.rb', line 543

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



565
566
567
568
569
570
 
# File 's3_express/cfn_directory_bucket.rb', line 565

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

Returns the Amazon Resource Name (ARN) of the specified bucket.

Example: arn:aws:s3express: *us-west-2* : *account_id* :bucket/ *bucket_base_name* -- *usw2-az1* --x-s3

Returns:

  • (String) 


252
253
254
 
# File 's3_express/cfn_directory_bucket.rb', line 252

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_availability_zone_name ⇒ String

Returns the code for the Availability Zone or the Local Zone where the directory bucket was created.

Example value for an Availability Zone code: us-east-1f

An Availability Zone code might not represent the same physical location for different AWS accounts. For more information, see Availability Zones and Regions in the Amazon S3 User Guide .

Returns:

  • (String) 


263
264
265
 
# File 's3_express/cfn_directory_bucket.rb', line 263

def attr_availability_zone_name()
  jsii_get_property("attrAvailabilityZoneName")
end

#bucket_encryption ⇒ AWSCDK::IResolvable, ...

Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS).

Returns:



308
309
310
 
# File 's3_express/cfn_directory_bucket.rb', line 308

def bucket_encryption()
  jsii_get_property("bucketEncryption")
end

#bucket_encryption=(value) ⇒ Object 



312
313
314
315
316
 
# File 's3_express/cfn_directory_bucket.rb', line 312

def bucket_encryption=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Express::CfnDirectoryBucket::BucketEncryptionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM2V4cHJlc3MuQ2ZuRGlyZWN0b3J5QnVja2V0LkJ1Y2tldEVuY3J5cHRpb25Qcm9wZXJ0eSJ9XX19")), "bucketEncryption") unless value.nil?
  jsii_set_property("bucketEncryption", value)
end

#bucket_name ⇒ String?

A name for the bucket.

Returns:

  • (String, nil) 


321
322
323
 
# File 's3_express/cfn_directory_bucket.rb', line 321

def bucket_name()
  jsii_get_property("bucketName")
end

#bucket_name=(value) ⇒ Object 



325
326
327
328
 
# File 's3_express/cfn_directory_bucket.rb', line 325

def bucket_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketName") unless value.nil?
  jsii_set_property("bucketName", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



270
271
272
 
# File 's3_express/cfn_directory_bucket.rb', line 270

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



196
197
198
 
# File 's3_express/cfn_directory_bucket.rb', line 196

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


201
202
203
 
# File 's3_express/cfn_directory_bucket.rb', line 201

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


574
575
576
577
 
# File 's3_express/cfn_directory_bucket.rb', line 574

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


206
207
208
 
# File 's3_express/cfn_directory_bucket.rb', line 206

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


213
214
215
 
# File 's3_express/cfn_directory_bucket.rb', line 213

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


158
159
160
 
# File 's3_express/cfn_directory_bucket.rb', line 158

def creation_stack()
  jsii_get_property("creationStack")
end

#data_redundancy ⇒ String

The number of Zone (Availability Zone or Local Zone) that's used for redundancy for the bucket.

Returns:

  • (String) 


284
285
286
 
# File 's3_express/cfn_directory_bucket.rb', line 284

def data_redundancy()
  jsii_get_property("dataRedundancy")
end

#data_redundancy=(value) ⇒ Object 



288
289
290
291
 
# File 's3_express/cfn_directory_bucket.rb', line 288

def data_redundancy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataRedundancy")
  jsii_set_property("dataRedundancy", value)
end

#directory_bucket_ref ⇒ AWSCDK::Interfaces::AWSS3Express::DirectoryBucketReference

A reference to a DirectoryBucket resource.

Returns:



277
278
279
 
# File 's3_express/cfn_directory_bucket.rb', line 277

def directory_bucket_ref()
  jsii_get_property("directoryBucketRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



218
219
220
 
# File 's3_express/cfn_directory_bucket.rb', line 218

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



587
588
589
590
591
 
# File 's3_express/cfn_directory_bucket.rb', line 587

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



598
599
600
601
 
# File 's3_express/cfn_directory_bucket.rb', line 598

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



668
669
670
671
 
# File 's3_express/cfn_directory_bucket.rb', line 668

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#inventory_configurations ⇒ AWSCDK::IResolvable, ...

The inventory configuration for an Amazon S3 Express bucket.

Returns:



333
334
335
 
# File 's3_express/cfn_directory_bucket.rb', line 333

def inventory_configurations()
  jsii_get_property("inventoryConfigurations")
end

#inventory_configurations=(value) ⇒ Object 



337
338
339
340
 
# File 's3_express/cfn_directory_bucket.rb', line 337

def inventory_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczNleHByZXNzLkNmbkRpcmVjdG9yeUJ1Y2tldC5JbnZlbnRvcnlDb25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "inventoryConfigurations") unless value.nil?
  jsii_set_property("inventoryConfigurations", value)
end

#lifecycle_configuration ⇒ AWSCDK::IResolvable, ...

Container for lifecycle rules.

You can add as many as 1000 rules.

Returns:



347
348
349
 
# File 's3_express/cfn_directory_bucket.rb', line 347

def lifecycle_configuration()
  jsii_get_property("lifecycleConfiguration")
end

#lifecycle_configuration=(value) ⇒ Object 



351
352
353
354
355
 
# File 's3_express/cfn_directory_bucket.rb', line 351

def lifecycle_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Express::CfnDirectoryBucket::LifecycleConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM2V4cHJlc3MuQ2ZuRGlyZWN0b3J5QnVja2V0LkxpZmVjeWNsZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "lifecycleConfiguration") unless value.nil?
  jsii_set_property("lifecycleConfiguration", value)
end

#location_name ⇒ String

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

Returns:

  • (String) 


296
297
298
 
# File 's3_express/cfn_directory_bucket.rb', line 296

def location_name()
  jsii_get_property("locationName")
end

#location_name=(value) ⇒ Object 



300
301
302
303
 
# File 's3_express/cfn_directory_bucket.rb', line 300

def location_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "locationName")
  jsii_set_property("locationName", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


170
171
172
 
# File 's3_express/cfn_directory_bucket.rb', line 170

def logical_id()
  jsii_get_property("logicalId")
end

#metrics_configurations ⇒ AWSCDK::IResolvable, ...

Specifies the metrics configurations for the Amazon S3 Express bucket.

Returns:



360
361
362
 
# File 's3_express/cfn_directory_bucket.rb', line 360

def metrics_configurations()
  jsii_get_property("metricsConfigurations")
end

#metrics_configurations=(value) ⇒ Object 



364
365
366
367
 
# File 's3_express/cfn_directory_bucket.rb', line 364

def metrics_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczNleHByZXNzLkNmbkRpcmVjdG9yeUJ1Y2tldC5NZXRyaWNzQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "metricsConfigurations") unless value.nil?
  jsii_set_property("metricsConfigurations", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


153
154
155
 
# File 's3_express/cfn_directory_bucket.rb', line 153

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



609
610
611
 
# File 's3_express/cfn_directory_bucket.rb', line 609

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



616
617
618
 
# File 's3_express/cfn_directory_bucket.rb', line 616

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



409
410
411
412
 
# File 's3_express/cfn_directory_bucket.rb', line 409

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


189
190
191
 
# File 's3_express/cfn_directory_bucket.rb', line 189

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



627
628
629
630
 
# File 's3_express/cfn_directory_bucket.rb', line 627

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


634
635
636
637
 
# File 's3_express/cfn_directory_bucket.rb', line 634

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



644
645
646
647
648
 
# File 's3_express/cfn_directory_bucket.rb', line 644

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



653
654
655
 
# File 's3_express/cfn_directory_bucket.rb', line 653

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



179
180
181
 
# File 's3_express/cfn_directory_bucket.rb', line 179

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of tags that you can apply to the S3 directory bucket.

Returns:



372
373
374
 
# File 's3_express/cfn_directory_bucket.rb', line 372

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



376
377
378
379
380
 
# File 's3_express/cfn_directory_bucket.rb', line 376

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



385
386
387
 
# File 's3_express/cfn_directory_bucket.rb', line 385

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


226
227
228
 
# File 's3_express/cfn_directory_bucket.rb', line 226

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


236
237
238
 
# File 's3_express/cfn_directory_bucket.rb', line 236

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


659
660
661
662
 
# File 's3_express/cfn_directory_bucket.rb', line 659

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


398
399
400
401
402
403
 
# File 's3_express/cfn_directory_bucket.rb', line 398

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end