Class CfnMissionProfile
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.groundstation.CfnMissionProfile
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:44.295Z")
@Stability(Stable)
public class CfnMissionProfile
extends CfnResource
implements IInspectable, ITaggable
Mission profiles specify parameters and provide references to config objects to define how Ground Station lists and executes contacts.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.groundstation.*; CfnMissionProfile cfnMissionProfile = CfnMissionProfile.Builder.create(this, "MyCfnMissionProfile") .dataflowEdges(List.of(DataflowEdgeProperty.builder() .destination("destination") .source("source") .build())) .minimumViableContactDurationSeconds(123) .name("name") .trackingConfigArn("trackingConfigArn") // the properties below are optional .contactPostPassDurationSeconds(123) .contactPrePassDurationSeconds(123) .streamsKmsKey(StreamsKmsKeyProperty.builder() .kmsAliasArn("kmsAliasArn") .kmsKeyArn("kmsKeyArn") .build()) .streamsKmsRole("streamsKmsRole") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnMissionProfile
.static interface
A dataflow edge defines from where and to where data will flow during a contact.static interface
KMS key info.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnMissionProfile
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnMissionProfile
(software.amazon.jsii.JsiiObjectRef objRef) CfnMissionProfile
(software.constructs.Construct scope, String id, CfnMissionProfileProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the mission profile, such asarn:aws:groundstation:us-east-2:1234567890:mission-profile/9940bf3b-d2ba-427e-9906-842b5e5d2296
.The ID of the mission profile, such as9940bf3b-d2ba-427e-9906-842b5e5d2296
.The region of the mission profile.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.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.A list containing lists of config ARNs.Minimum length of a contact in seconds that Ground Station will return when listing contacts.getName()
The name of the mission profile.KMS key to use for encrypting streams.Role to use for encrypting streams with KMS key.getTags()
Tag Manager which manages the tags for this resource.Tags assigned to the mission profile.The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
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.void
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.void
setDataflowEdges
(List<Object> value) A list containing lists of config ARNs.void
setDataflowEdges
(IResolvable value) A list containing lists of config ARNs.void
Minimum length of a contact in seconds that Ground Station will return when listing contacts.void
The name of the mission profile.void
setStreamsKmsKey
(IResolvable value) KMS key to use for encrypting streams.void
KMS key to use for encrypting streams.void
setStreamsKmsRole
(String value) Role to use for encrypting streams with KMS key.void
setTagsRaw
(List<CfnTag> value) Tags assigned to the mission profile.void
setTrackingConfigArn
(String value) The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnMissionProfile
protected CfnMissionProfile(software.amazon.jsii.JsiiObjectRef objRef) -
CfnMissionProfile
protected CfnMissionProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnMissionProfile
@Stability(Stable) public CfnMissionProfile(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMissionProfileProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the mission profile, such asarn:aws:groundstation:us-east-2:1234567890:mission-profile/9940bf3b-d2ba-427e-9906-842b5e5d2296
. -
getAttrId
The ID of the mission profile, such as9940bf3b-d2ba-427e-9906-842b5e5d2296
. -
getAttrRegion
The region of the mission profile. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDataflowEdges
A list containing lists of config ARNs. -
setDataflowEdges
A list containing lists of config ARNs. -
setDataflowEdges
A list containing lists of config ARNs. -
getMinimumViableContactDurationSeconds
Minimum length of a contact in seconds that Ground Station will return when listing contacts. -
setMinimumViableContactDurationSeconds
Minimum length of a contact in seconds that Ground Station will return when listing contacts. -
getName
The name of the mission profile. -
setName
The name of the mission profile. -
getTrackingConfigArn
The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact. -
setTrackingConfigArn
The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact. -
getContactPostPassDurationSeconds
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. -
setContactPostPassDurationSeconds
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. -
getContactPrePassDurationSeconds
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. -
setContactPrePassDurationSeconds
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. -
getStreamsKmsKey
KMS key to use for encrypting streams. -
setStreamsKmsKey
KMS key to use for encrypting streams. -
setStreamsKmsKey
@Stability(Stable) public void setStreamsKmsKey(@Nullable CfnMissionProfile.StreamsKmsKeyProperty value) KMS key to use for encrypting streams. -
getStreamsKmsRole
Role to use for encrypting streams with KMS key. -
setStreamsKmsRole
Role to use for encrypting streams with KMS key. -
getTagsRaw
Tags assigned to the mission profile. -
setTagsRaw
Tags assigned to the mission profile.
-