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,IMissionProfileRef,IEnvironmentAware,ITaggable,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
date="2025-12-05T22:26:37.747Z")
@Stability(Stable)
public class CfnMissionProfile
extends CfnResource
implements IInspectable, IMissionProfileRef, 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")
.kmsAliasName("kmsAliasName")
.kmsKeyArn("kmsKeyArn")
.build())
.streamsKmsRole("streamsKmsRole")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnMissionProfile.static interfaceA dataflow edge defines from where and to where data will flow during a contact.static interfaceKMS key info.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.groundstation.IMissionProfileRef
IMissionProfileRef.Jsii$Default, IMissionProfileRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnMissionProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnMissionProfile(software.amazon.jsii.JsiiObjectRef objRef) CfnMissionProfile(software.constructs.Construct scope, String id, CfnMissionProfileProps props) Create a newAWS::GroundStation::MissionProfile. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringarnForMissionProfile(IMissionProfileRef resource) static IMissionProfileReffromMissionProfileId(software.constructs.Construct scope, String id, String missionProfileId) Creates a new IMissionProfileRef from a missionProfileId.The 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.A reference to a MissionProfile resource.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.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.static BooleanChecks whether the given object is a CfnMissionProfile.renderProperties(Map<String, Object> props) voidAmount 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.voidAmount 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.voidsetDataflowEdges(List<Object> value) A list containing lists of config ARNs.voidsetDataflowEdges(IResolvable value) A list containing lists of config ARNs.voidMinimum length of a contact in seconds that Ground Station will return when listing contacts.voidThe name of the mission profile.voidsetStreamsKmsKey(IResolvable value) KMS key to use for encrypting streams.voidKMS key to use for encrypting streams.voidsetStreamsKmsRole(String value) Role to use for encrypting streams with KMS key.voidsetTagsRaw(List<CfnTag> value) Tags assigned to the mission profile.voidsetTrackingConfigArn(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, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods 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) Create a newAWS::GroundStation::MissionProfile.- 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
-
arnForMissionProfile
@Stability(Stable) @NotNull public static String arnForMissionProfile(@NotNull IMissionProfileRef resource) - Parameters:
resource- This parameter is required.
-
fromMissionProfileId
@Stability(Stable) @NotNull public static IMissionProfileRef fromMissionProfileId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String missionProfileId) Creates a new IMissionProfileRef from a missionProfileId.- Parameters:
scope- This parameter is required.id- This parameter is required.missionProfileId- This parameter is required.
-
isCfnMissionProfile
Checks whether the given object is a CfnMissionProfile.- Parameters:
x- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin 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:
renderPropertiesin 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:
getCfnPropertiesin classCfnResource
-
getMissionProfileRef
A reference to a MissionProfile resource.- Specified by:
getMissionProfileRefin interfaceIMissionProfileRef
-
getTags
Tag Manager which manages the tags for this resource. -
getDataflowEdges
A list containing lists of config ARNs.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnMissionProfile.DataflowEdgeProperty> -
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.Returns union: either
IResolvableorCfnMissionProfile.StreamsKmsKeyProperty -
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.
-