Class: AWSCDK::S3Express::CfnDirectoryBucket::InventoryConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3_express/cfn_directory_bucket.rb

Overview

Specifies an inventory configuration for an Amazon S3 Express bucket.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(destination:, enabled:, id:, included_object_versions:, schedule_frequency:, optional_fields: nil, prefix: nil) ⇒ InventoryConfigurationProperty

Returns a new instance of InventoryConfigurationProperty.

Parameters:

  • destination (AWSCDK::IResolvable, AWSCDK::S3Express::CfnDirectoryBucket::DestinationProperty) —

    Specifies information about where to publish inventory reports for an Amazon S3 Express bucket.

  • enabled (Boolean, AWSCDK::IResolvable) —

    Specifies whether the inventory is enabled or disabled.

  • id (String) —

    The ID used to identify the inventory configuration.

  • included_object_versions (String) —

    Object versions to include in the inventory list.

  • schedule_frequency (String) —

    Specifies the schedule for generating inventory results.

  • optional_fields (Array<String>, nil) (defaults to: nil) —

    Contains the optional fields that are included in the inventory results.

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

    The prefix that is prepended to all inventory results.



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 's3_express/cfn_directory_bucket.rb', line 823

def initialize(destination:, enabled:, id:, included_object_versions:, schedule_frequency:, optional_fields: nil, prefix: nil)
  @destination = destination.is_a?(Hash) ? ::AWSCDK::S3Express::CfnDirectoryBucket::DestinationProperty.new(**destination.transform_keys(&:to_sym)) : destination
  Jsii::Type.check_type(@destination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM2V4cHJlc3MuQ2ZuRGlyZWN0b3J5QnVja2V0LkRlc3RpbmF0aW9uUHJvcGVydHkifV19fQ==")), "destination")
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled")
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  @included_object_versions = included_object_versions
  Jsii::Type.check_type(@included_object_versions, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "includedObjectVersions")
  @schedule_frequency = schedule_frequency
  Jsii::Type.check_type(@schedule_frequency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheduleFrequency")
  @optional_fields = optional_fields
  Jsii::Type.check_type(@optional_fields, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "optionalFields") unless @optional_fields.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
end

Instance Attribute Details

#destination ⇒ AWSCDK::IResolvable, AWSCDK::S3Express::CfnDirectoryBucket::DestinationProperty (readonly)

Specifies information about where to publish inventory reports for an Amazon S3 Express bucket.

Returns:

See Also:



844
845
846
 
# File 's3_express/cfn_directory_bucket.rb', line 844

def destination
  @destination
end

#enabled ⇒ Boolean, AWSCDK::IResolvable (readonly)

Specifies whether the inventory is enabled or disabled.

Returns:

See Also:



849
850
851
 
# File 's3_express/cfn_directory_bucket.rb', line 849

def enabled
  @enabled
end

#id ⇒ String (readonly)

The ID used to identify the inventory configuration.

Returns:

  • (String)

See Also:



854
855
856
 
# File 's3_express/cfn_directory_bucket.rb', line 854

def id
  @id
end

#included_object_versions ⇒ String (readonly)

Object versions to include in the inventory list.

Returns:

  • (String)

See Also:



859
860
861
 
# File 's3_express/cfn_directory_bucket.rb', line 859

def included_object_versions
  @included_object_versions
end

#optional_fields ⇒ Array<String>? (readonly)

Contains the optional fields that are included in the inventory results.

Returns:

  • (Array<String>, nil)

See Also:



869
870
871
 
# File 's3_express/cfn_directory_bucket.rb', line 869

def optional_fields
  @optional_fields
end

#prefix ⇒ String? (readonly)

The prefix that is prepended to all inventory results.

Returns:

  • (String, nil)

See Also:



874
875
876
 
# File 's3_express/cfn_directory_bucket.rb', line 874

def prefix
  @prefix
end

#schedule_frequency ⇒ String (readonly)

Specifies the schedule for generating inventory results.

Returns:

  • (String)

See Also:



864
865
866
 
# File 's3_express/cfn_directory_bucket.rb', line 864

def schedule_frequency
  @schedule_frequency
end

Class Method Details

.jsii_properties ⇒ Object 



876
877
878
879
880
881
882
883
884
885
886
 
# File 's3_express/cfn_directory_bucket.rb', line 876

def self.jsii_properties
  {
    :destination => "destination",
    :enabled => "enabled",
    :id => "id",
    :included_object_versions => "includedObjectVersions",
    :schedule_frequency => "scheduleFrequency",
    :optional_fields => "optionalFields",
    :prefix => "prefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



888
889
890
891
892
893
894
895
896
897
898
899
900
 
# File 's3_express/cfn_directory_bucket.rb', line 888

def to_jsii
  result = {}
  result.merge!({
    "destination" => @destination,
    "enabled" => @enabled,
    "id" => @id,
    "includedObjectVersions" => @included_object_versions,
    "scheduleFrequency" => @schedule_frequency,
    "optionalFields" => @optional_fields,
    "prefix" => @prefix,
  })
  result.compact
end