Class: AWSCDK::GroundStation::CfnMissionProfile

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSGroundstation::IMissionProfileRef
Defined in:
ground_station/cfn_mission_profile.rb

Overview

Mission profiles specify parameters and provide references to config objects to define how Ground Station lists and executes contacts.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMissionProfile

Create a new AWS::GroundStation::MissionProfile.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::GroundStation::CfnMissionProfileProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'ground_station/cfn_mission_profile.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::GroundStation::CfnMissionProfileProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ3JvdW5kc3RhdGlvbi5DZm5NaXNzaW9uUHJvZmlsZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_mission_profile(resource) ⇒ String

Parameters:

Returns:

  • (String) 


83
84
85
86
 
# File 'ground_station/cfn_mission_profile.rb', line 83

def self.arn_for_mission_profile(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19ncm91bmRzdGF0aW9uLklNaXNzaW9uUHJvZmlsZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_groundstation.CfnMissionProfile", "arnForMissionProfile", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


203
204
205
 
# File 'ground_station/cfn_mission_profile.rb', line 203

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_groundstation.CfnMissionProfile", "CFN_RESOURCE_TYPE_NAME")
end

.from_mission_profile_id(scope, id, mission_profile_id) ⇒ AWSCDK::Interfaces::AWSGroundstation::IMissionProfileRef

Creates a new IMissionProfileRef from a missionProfileId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • mission_profile_id (String)

Returns:



94
95
96
97
98
99
 
# File 'ground_station/cfn_mission_profile.rb', line 94

def self.from_mission_profile_id(scope, id, mission_profile_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(mission_profile_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "missionProfileId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_groundstation.CfnMissionProfile", "fromMissionProfileId", [scope, id, mission_profile_id])
end

.is_cfn_mission_profile(x) ⇒ Boolean

Checks whether the given object is a CfnMissionProfile.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


105
106
107
108
 
# File 'ground_station/cfn_mission_profile.rb', line 105

def self.is_cfn_mission_profile(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_groundstation.CfnMissionProfile", "isCfnMissionProfile", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'ground_station/cfn_mission_profile.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_region => { kind: :property, name: "attrRegion", is_optional: false },
    :mission_profile_ref => { kind: :property, name: "missionProfileRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :dataflow_edges => { kind: :property, name: "dataflowEdges", is_optional: false },
    :minimum_viable_contact_duration_seconds => { kind: :property, name: "minimumViableContactDurationSeconds", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :tracking_config_arn => { kind: :property, name: "trackingConfigArn", is_optional: false },
    :contact_post_pass_duration_seconds => { kind: :property, name: "contactPostPassDurationSeconds", is_optional: true },
    :contact_pre_pass_duration_seconds => { kind: :property, name: "contactPrePassDurationSeconds", is_optional: true },
    :streams_kms_key => { kind: :property, name: "streamsKmsKey", is_optional: true },
    :streams_kms_role => { kind: :property, name: "streamsKmsRole", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :telemetry_sink_config_arn => { kind: :property, name: "telemetrySinkConfigArn", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



400
401
402
403
 
# File 'ground_station/cfn_mission_profile.rb', line 400

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



412
413
414
415
 
# File 'ground_station/cfn_mission_profile.rb', line 412

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



422
423
424
425
 
# File 'ground_station/cfn_mission_profile.rb', line 422

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



433
434
435
436
437
 
# File 'ground_station/cfn_mission_profile.rb', line 433

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


490
491
492
493
494
 
# File 'ground_station/cfn_mission_profile.rb', line 490

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



500
501
502
503
 
# File 'ground_station/cfn_mission_profile.rb', line 500

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



512
513
514
515
516
 
# File 'ground_station/cfn_mission_profile.rb', line 512

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



525
526
527
528
 
# File 'ground_station/cfn_mission_profile.rb', line 525

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



547
548
549
550
551
552
 
# File 'ground_station/cfn_mission_profile.rb', line 547

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN of the mission profile, such as arn:aws:groundstation:us-east-2:1234567890:mission-profile/9940bf3b-d2ba-427e-9906-842b5e5d2296 .

Returns:

  • (String) 


210
211
212
 
# File 'ground_station/cfn_mission_profile.rb', line 210

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_id ⇒ String

The ID of the mission profile, such as 9940bf3b-d2ba-427e-9906-842b5e5d2296 .

Returns:

  • (String) 


217
218
219
 
# File 'ground_station/cfn_mission_profile.rb', line 217

def attr_id()
  jsii_get_property("attrId")
end

#attr_region ⇒ String

The region of the mission profile.

Returns:

  • (String) 


224
225
226
 
# File 'ground_station/cfn_mission_profile.rb', line 224

def attr_region()
  jsii_get_property("attrRegion")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



156
157
158
 
# File 'ground_station/cfn_mission_profile.rb', line 156

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


161
162
163
 
# File 'ground_station/cfn_mission_profile.rb', line 161

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


556
557
558
559
 
# File 'ground_station/cfn_mission_profile.rb', line 556

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


166
167
168
 
# File 'ground_station/cfn_mission_profile.rb', line 166

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


173
174
175
 
# File 'ground_station/cfn_mission_profile.rb', line 173

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#contact_post_pass_duration_seconds ⇒ Numeric?

Amount of time in seconds after a contact ends that you’d like to receive a Ground Station Contact State Change indicating the pass has finished.

Returns:

  • (Numeric, nil) 


293
294
295
 
# File 'ground_station/cfn_mission_profile.rb', line 293

def contact_post_pass_duration_seconds()
  jsii_get_property("contactPostPassDurationSeconds")
end

#contact_post_pass_duration_seconds=(value) ⇒ Object 



297
298
299
300
 
# File 'ground_station/cfn_mission_profile.rb', line 297

def contact_post_pass_duration_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "contactPostPassDurationSeconds") unless value.nil?
  jsii_set_property("contactPostPassDurationSeconds", value)
end

#contact_pre_pass_duration_seconds ⇒ Numeric?

Amount of time in seconds prior to contact start that you'd like to receive a Ground Station Contact State Change Event indicating an upcoming pass.

Returns:

  • (Numeric, nil) 


305
306
307
 
# File 'ground_station/cfn_mission_profile.rb', line 305

def contact_pre_pass_duration_seconds()
  jsii_get_property("contactPrePassDurationSeconds")
end

#contact_pre_pass_duration_seconds=(value) ⇒ Object 



309
310
311
312
 
# File 'ground_station/cfn_mission_profile.rb', line 309

def contact_pre_pass_duration_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "contactPrePassDurationSeconds") unless value.nil?
  jsii_set_property("contactPrePassDurationSeconds", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


118
119
120
 
# File 'ground_station/cfn_mission_profile.rb', line 118

def creation_stack()
  jsii_get_property("creationStack")
end

#dataflow_edges ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::GroundStation::CfnMissionProfile::DataflowEdgeProperty>

A list containing lists of config ARNs.

Returns:



245
246
247
 
# File 'ground_station/cfn_mission_profile.rb', line 245

def dataflow_edges()
  jsii_get_property("dataflowEdges")
end

#dataflow_edges=(value) ⇒ Object 



249
250
251
252
 
# File 'ground_station/cfn_mission_profile.rb', line 249

def dataflow_edges=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ3JvdW5kc3RhdGlvbi5DZm5NaXNzaW9uUHJvZmlsZS5EYXRhZmxvd0VkZ2VQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "dataflowEdges")
  jsii_set_property("dataflowEdges", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



178
179
180
 
# File 'ground_station/cfn_mission_profile.rb', line 178

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



569
570
571
572
573
 
# File 'ground_station/cfn_mission_profile.rb', line 569

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



580
581
582
583
 
# File 'ground_station/cfn_mission_profile.rb', line 580

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



650
651
652
653
 
# File 'ground_station/cfn_mission_profile.rb', line 650

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


130
131
132
 
# File 'ground_station/cfn_mission_profile.rb', line 130

def logical_id()
  jsii_get_property("logicalId")
end

#minimum_viable_contact_duration_seconds ⇒ Numeric

Minimum length of a contact in seconds that Ground Station will return when listing contacts.

Returns:

  • (Numeric) 


257
258
259
 
# File 'ground_station/cfn_mission_profile.rb', line 257

def minimum_viable_contact_duration_seconds()
  jsii_get_property("minimumViableContactDurationSeconds")
end

#minimum_viable_contact_duration_seconds=(value) ⇒ Object 



261
262
263
264
 
# File 'ground_station/cfn_mission_profile.rb', line 261

def minimum_viable_contact_duration_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minimumViableContactDurationSeconds")
  jsii_set_property("minimumViableContactDurationSeconds", value)
end

#mission_profile_ref ⇒ AWSCDK::Interfaces::AWSGroundstation::MissionProfileReference

A reference to a MissionProfile resource.

Returns:



231
232
233
 
# File 'ground_station/cfn_mission_profile.rb', line 231

def mission_profile_ref()
  jsii_get_property("missionProfileRef")
end

#name ⇒ String

The name of the mission profile.

Returns:

  • (String) 


269
270
271
 
# File 'ground_station/cfn_mission_profile.rb', line 269

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



273
274
275
276
 
# File 'ground_station/cfn_mission_profile.rb', line 273

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


113
114
115
 
# File 'ground_station/cfn_mission_profile.rb', line 113

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



591
592
593
 
# File 'ground_station/cfn_mission_profile.rb', line 591

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



598
599
600
 
# File 'ground_station/cfn_mission_profile.rb', line 598

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



391
392
393
394
 
# File 'ground_station/cfn_mission_profile.rb', line 391

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


149
150
151
 
# File 'ground_station/cfn_mission_profile.rb', line 149

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



609
610
611
612
 
# File 'ground_station/cfn_mission_profile.rb', line 609

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


616
617
618
619
 
# File 'ground_station/cfn_mission_profile.rb', line 616

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



626
627
628
629
630
 
# File 'ground_station/cfn_mission_profile.rb', line 626

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



635
636
637
 
# File 'ground_station/cfn_mission_profile.rb', line 635

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



139
140
141
 
# File 'ground_station/cfn_mission_profile.rb', line 139

def stack()
  jsii_get_property("stack")
end

#streams_kms_key ⇒ AWSCDK::IResolvable, ...

KMS key to use for encrypting streams.

Returns:



317
318
319
 
# File 'ground_station/cfn_mission_profile.rb', line 317

def streams_kms_key()
  jsii_get_property("streamsKmsKey")
end

#streams_kms_key=(value) ⇒ Object 



321
322
323
324
325
 
# File 'ground_station/cfn_mission_profile.rb', line 321

def streams_kms_key=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GroundStation::CfnMissionProfile::StreamsKMSKeyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ncm91bmRzdGF0aW9uLkNmbk1pc3Npb25Qcm9maWxlLlN0cmVhbXNLbXNLZXlQcm9wZXJ0eSJ9XX19")), "streamsKmsKey") unless value.nil?
  jsii_set_property("streamsKmsKey", value)
end

#streams_kms_role ⇒ String?

Role to use for encrypting streams with KMS key.

Returns:

  • (String, nil) 


330
331
332
 
# File 'ground_station/cfn_mission_profile.rb', line 330

def streams_kms_role()
  jsii_get_property("streamsKmsRole")
end

#streams_kms_role=(value) ⇒ Object 



334
335
336
337
 
# File 'ground_station/cfn_mission_profile.rb', line 334

def streams_kms_role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamsKmsRole") unless value.nil?
  jsii_set_property("streamsKmsRole", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



238
239
240
 
# File 'ground_station/cfn_mission_profile.rb', line 238

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Tags assigned to the mission profile.

Returns:



342
343
344
 
# File 'ground_station/cfn_mission_profile.rb', line 342

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



346
347
348
349
350
 
# File 'ground_station/cfn_mission_profile.rb', line 346

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#telemetry_sink_config_arn ⇒ String?

ARN of a Config resource of type TelemetrySinkConfig used for telemetry data sink configuration.

Returns:

  • (String, nil) 


355
356
357
 
# File 'ground_station/cfn_mission_profile.rb', line 355

def telemetry_sink_config_arn()
  jsii_get_property("telemetrySinkConfigArn")
end

#telemetry_sink_config_arn=(value) ⇒ Object 



359
360
361
362
 
# File 'ground_station/cfn_mission_profile.rb', line 359

def telemetry_sink_config_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "telemetrySinkConfigArn") unless value.nil?
  jsii_set_property("telemetrySinkConfigArn", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



367
368
369
 
# File 'ground_station/cfn_mission_profile.rb', line 367

def to_string()
  jsii_call_method("toString", [])
end

#tracking_config_arn ⇒ String

The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact.

Returns:

  • (String) 


281
282
283
 
# File 'ground_station/cfn_mission_profile.rb', line 281

def tracking_config_arn()
  jsii_get_property("trackingConfigArn")
end

#tracking_config_arn=(value) ⇒ Object 



285
286
287
288
 
# File 'ground_station/cfn_mission_profile.rb', line 285

def tracking_config_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trackingConfigArn")
  jsii_set_property("trackingConfigArn", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


186
187
188
 
# File 'ground_station/cfn_mission_profile.rb', line 186

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


196
197
198
 
# File 'ground_station/cfn_mission_profile.rb', line 196

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


641
642
643
644
 
# File 'ground_station/cfn_mission_profile.rb', line 641

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


380
381
382
383
384
385
 
# File 'ground_station/cfn_mission_profile.rb', line 380

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end