Class: AWSCDK::S3Tables::CfnTable::SnapshotManagementProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3_tables/cfn_table.rb

Overview

Contains details about the snapshot management settings for an Iceberg table.

The oldest snapshot expires when its age exceeds the max_snapshot_age_hours and the total number of snapshots exceeds the value for the minimum number of snapshots to keep min_snapshots_to_keep .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(max_snapshot_age_hours: nil, min_snapshots_to_keep: nil, status: nil) ⇒ SnapshotManagementProperty

Returns a new instance of SnapshotManagementProperty.

Parameters:

  • max_snapshot_age_hours (Numeric, nil) (defaults to: nil) —

    The maximum age of a snapshot before it can be expired.

  • min_snapshots_to_keep (Numeric, nil) (defaults to: nil) —

    The minimum number of snapshots to keep.

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

    The status of the maintenance configuration.



1237
1238
1239
1240
1241
1242
1243
1244
 
# File 's3_tables/cfn_table.rb', line 1237

def initialize(max_snapshot_age_hours: nil, min_snapshots_to_keep: nil, status: nil)
  @max_snapshot_age_hours = max_snapshot_age_hours
  Jsii::Type.check_type(@max_snapshot_age_hours, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxSnapshotAgeHours") unless @max_snapshot_age_hours.nil?
  @min_snapshots_to_keep = min_snapshots_to_keep
  Jsii::Type.check_type(@min_snapshots_to_keep, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minSnapshotsToKeep") unless @min_snapshots_to_keep.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
end

Instance Attribute Details

#max_snapshot_age_hours ⇒ Numeric? (readonly)

The maximum age of a snapshot before it can be expired.

Returns:

  • (Numeric, nil)

See Also:



1250
1251
1252
 
# File 's3_tables/cfn_table.rb', line 1250

def max_snapshot_age_hours
  @max_snapshot_age_hours
end

#min_snapshots_to_keep ⇒ Numeric? (readonly)

The minimum number of snapshots to keep.

Returns:

  • (Numeric, nil)

See Also:



1255
1256
1257
 
# File 's3_tables/cfn_table.rb', line 1255

def min_snapshots_to_keep
  @min_snapshots_to_keep
end

#status ⇒ String? (readonly)

The status of the maintenance configuration.

Returns:

  • (String, nil)

See Also:



1260
1261
1262
 
# File 's3_tables/cfn_table.rb', line 1260

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



1262
1263
1264
1265
1266
1267
1268
 
# File 's3_tables/cfn_table.rb', line 1262

def self.jsii_properties
  {
    :max_snapshot_age_hours => "maxSnapshotAgeHours",
    :min_snapshots_to_keep => "minSnapshotsToKeep",
    :status => "status",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1270
1271
1272
1273
1274
1275
1276
1277
1278
 
# File 's3_tables/cfn_table.rb', line 1270

def to_jsii
  result = {}
  result.merge!({
    "maxSnapshotAgeHours" => @max_snapshot_age_hours,
    "minSnapshotsToKeep" => @min_snapshots_to_keep,
    "status" => @status,
  })
  result.compact
end