Class: AWSCDK::GroundStation::CfnConfig::S3RecordingConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ground_station/cfn_config.rb

Overview

Provides information about how AWS Ground Station should save downlink data to S3.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_arn: nil, prefix: nil, role_arn: nil) ⇒ S3RecordingConfigProperty

Returns a new instance of S3RecordingConfigProperty.

Parameters:

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

    S3 Bucket where the data is written.

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

    The prefix of the S3 data object.

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

    Defines the ARN of the role assumed for putting archives to S3.



1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'ground_station/cfn_config.rb', line 1109

def initialize(bucket_arn: nil, prefix: nil, role_arn: nil)
  @bucket_arn = bucket_arn
  Jsii::Type.check_type(@bucket_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketArn") unless @bucket_arn.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
end

Instance Attribute Details

#bucket_arn ⇒ String? (readonly)

S3 Bucket where the data is written.

The name of the S3 Bucket provided must begin with aws-groundstation .

Returns:

  • (String, nil)

See Also:



1124
1125
1126
 
# File 'ground_station/cfn_config.rb', line 1124

def bucket_arn
  @bucket_arn
end

#prefix ⇒ String? (readonly)

The prefix of the S3 data object.

If you choose to use any optional keys for substitution, these values will be replaced with the corresponding information from your contact details. For example, a prefix of {satellite_id}/{year}/{month}/{day}/ will replaced with fake_satellite_id/2021/01/10/

Optional keys for substitution : {satellite_id} | {config-name} | {config-id} | {year} | {month} | {day}

Returns:

  • (String, nil)

See Also:



1133
1134
1135
 
# File 'ground_station/cfn_config.rb', line 1133

def prefix
  @prefix
end

#role_arn ⇒ String? (readonly)

Defines the ARN of the role assumed for putting archives to S3.

Returns:

  • (String, nil)

See Also:



1138
1139
1140
 
# File 'ground_station/cfn_config.rb', line 1138

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



1140
1141
1142
1143
1144
1145
1146
 
# File 'ground_station/cfn_config.rb', line 1140

def self.jsii_properties
  {
    :bucket_arn => "bucketArn",
    :prefix => "prefix",
    :role_arn => "roleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'ground_station/cfn_config.rb', line 1148

def to_jsii
  result = {}
  result.merge!({
    "bucketArn" => @bucket_arn,
    "prefix" => @prefix,
    "roleArn" => @role_arn,
  })
  result.compact
end