Class: AWSCDK::S3::IntelligentTieringConfiguration

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3/intelligent_tiering_configuration.rb

Overview

The intelligent tiering configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, archive_access_tier_time: nil, deep_archive_access_tier_time: nil, prefix: nil, tags: nil) ⇒ IntelligentTieringConfiguration

Returns a new instance of IntelligentTieringConfiguration.

Parameters:

  • name (String) —

    Configuration name.

  • archive_access_tier_time (AWSCDK::Duration, nil) (defaults to: nil) —

    When enabled, Intelligent-Tiering will automatically move objects that haven’t been accessed for a minimum of 90 days to the Archive Access tier.

  • deep_archive_access_tier_time (AWSCDK::Duration, nil) (defaults to: nil) —

    When enabled, Intelligent-Tiering will automatically move objects that haven’t been accessed for a minimum of 180 days to the Deep Archive Access tier.

  • prefix (String, nil) (defaults to: nil) —

    Add a filter to limit the scope of this configuration to a single prefix.

  • tags (Array<AWSCDK::S3::Tag>, nil) (defaults to: nil) —

    You can limit the scope of this rule to the key value pairs added below.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 's3/intelligent_tiering_configuration.rb', line 12

def initialize(name:, archive_access_tier_time: nil, deep_archive_access_tier_time: nil, prefix: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @archive_access_tier_time = archive_access_tier_time
  Jsii::Type.check_type(@archive_access_tier_time, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "archiveAccessTierTime") unless @archive_access_tier_time.nil?
  @deep_archive_access_tier_time = deep_archive_access_tier_time
  Jsii::Type.check_type(@deep_archive_access_tier_time, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "deepArchiveAccessTierTime") unless @deep_archive_access_tier_time.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::S3::Tag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zMy5UYWcifSwia2luZCI6ImFycmF5In19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#archive_access_tier_time ⇒ AWSCDK::Duration? (readonly)

Note:

Default: Objects will not move to Glacier

When enabled, Intelligent-Tiering will automatically move objects that haven’t been accessed for a minimum of 90 days to the Archive Access tier.

Returns:



33
34
35
 
# File 's3/intelligent_tiering_configuration.rb', line 33

def archive_access_tier_time
  @archive_access_tier_time
end

#deep_archive_access_tier_time ⇒ AWSCDK::Duration? (readonly)

Note:

Default: Objects will not move to Glacier Deep Access

When enabled, Intelligent-Tiering will automatically move objects that haven’t been accessed for a minimum of 180 days to the Deep Archive Access tier.

Returns:



38
39
40
 
# File 's3/intelligent_tiering_configuration.rb', line 38

def deep_archive_access_tier_time
  @deep_archive_access_tier_time
end

#name ⇒ String (readonly)

Configuration name.

Returns:

  • (String) 


28
29
30
 
# File 's3/intelligent_tiering_configuration.rb', line 28

def name
  @name
end

#prefix ⇒ String? (readonly)

Note:

Default: this configuration will apply to all objects in the bucket.

Add a filter to limit the scope of this configuration to a single prefix.

Returns:

  • (String, nil) 


43
44
45
 
# File 's3/intelligent_tiering_configuration.rb', line 43

def prefix
  @prefix
end

#tags ⇒ Array<AWSCDK::S3::Tag>? (readonly)

Note:

Default: No filtering will be performed on tags

You can limit the scope of this rule to the key value pairs added below.

Returns:



48
49
50
 
# File 's3/intelligent_tiering_configuration.rb', line 48

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 's3/intelligent_tiering_configuration.rb', line 50

def self.jsii_properties
  {
    :name => "name",
    :archive_access_tier_time => "archiveAccessTierTime",
    :deep_archive_access_tier_time => "deepArchiveAccessTierTime",
    :prefix => "prefix",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
 
# File 's3/intelligent_tiering_configuration.rb', line 60

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "archiveAccessTierTime" => @archive_access_tier_time,
    "deepArchiveAccessTierTime" => @deep_archive_access_tier_time,
    "prefix" => @prefix,
    "tags" => @tags,
  })
  result.compact
end