Class: AWSCDK::EC2::CfnCapacityManagerDataExportProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ec2/cfn_capacity_manager_data_export_props.rb

Overview

Properties for defining a CfnCapacityManagerDataExport.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(output_format:, s3_bucket_name:, schedule:, s3_bucket_prefix: nil, tags: nil) ⇒ CfnCapacityManagerDataExportProps

Returns a new instance of CfnCapacityManagerDataExportProps.

Parameters:

  • output_format (String) —

    The file format of the exported data.

  • s3_bucket_name (String) —

    The name of the S3 bucket where export files are delivered.

  • schedule (String) —

    The frequency at which data exports are generated.

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

    The S3 key prefix used for organizing export files within the bucket.

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

    The tags associated with the data export configuration.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'ec2/cfn_capacity_manager_data_export_props.rb', line 14

def initialize(output_format:, s3_bucket_name:, schedule:, s3_bucket_prefix: nil, tags: nil)
  @output_format = output_format
  Jsii::Type.check_type(@output_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputFormat")
  @s3_bucket_name = s3_bucket_name
  Jsii::Type.check_type(@s3_bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BucketName")
  @schedule = schedule
  Jsii::Type.check_type(@schedule, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "schedule")
  @s3_bucket_prefix = s3_bucket_prefix
  Jsii::Type.check_type(@s3_bucket_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BucketPrefix") unless @s3_bucket_prefix.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#output_format ⇒ String (readonly)

The file format of the exported data.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'ec2/cfn_capacity_manager_data_export_props.rb', line 31

def output_format
  @output_format
end

#s3_bucket_name ⇒ String (readonly)

The name of the S3 bucket where export files are delivered.

Returns:

  • (String)

See Also:



36
37
38
 
# File 'ec2/cfn_capacity_manager_data_export_props.rb', line 36

def s3_bucket_name
  @s3_bucket_name
end

#s3_bucket_prefix ⇒ String? (readonly)

The S3 key prefix used for organizing export files within the bucket.

Returns:

  • (String, nil)

See Also:



46
47
48
 
# File 'ec2/cfn_capacity_manager_data_export_props.rb', line 46

def s3_bucket_prefix
  @s3_bucket_prefix
end

#schedule ⇒ String (readonly)

The frequency at which data exports are generated.

Returns:

  • (String)

See Also:



41
42
43
 
# File 'ec2/cfn_capacity_manager_data_export_props.rb', line 41

def schedule
  @schedule
end

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

The tags associated with the data export configuration.

Returns:

See Also:



51
52
53
 
# File 'ec2/cfn_capacity_manager_data_export_props.rb', line 51

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



53
54
55
56
57
58
59
60
61
 
# File 'ec2/cfn_capacity_manager_data_export_props.rb', line 53

def self.jsii_properties
  {
    :output_format => "outputFormat",
    :s3_bucket_name => "s3BucketName",
    :schedule => "schedule",
    :s3_bucket_prefix => "s3BucketPrefix",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'ec2/cfn_capacity_manager_data_export_props.rb', line 63

def to_jsii
  result = {}
  result.merge!({
    "outputFormat" => @output_format,
    "s3BucketName" => @s3_bucket_name,
    "schedule" => @schedule,
    "s3BucketPrefix" => @s3_bucket_prefix,
    "tags" => @tags,
  })
  result.compact
end