Package software.amazon.awscdk.services.groundstation

Interface CfnMissionProfileProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMissionProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.651Z")
@Stability(Stable)
public interface CfnMissionProfileProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMissionProfile.

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.*;
 CfnMissionProfileProps cfnMissionProfileProps = CfnMissionProfileProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMissionProfileProps.Builder	A builder for CfnMissionProfileProps
static final class	CfnMissionProfileProps.Jsii$Proxy	An implementation for CfnMissionProfileProps

Method Summary

Modifier and Type	Method	Description
static CfnMissionProfileProps.Builder	builder()
default Number	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.
default Number	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.
Object	getDataflowEdges()	A list containing lists of config ARNs.
Number	getMinimumViableContactDurationSeconds()	Minimum length of a contact in seconds that Ground Station will return when listing contacts.
String	getName()	The name of the mission profile.
default Object	getStreamsKmsKey()	KMS key to use for encrypting streams.
default String	getStreamsKmsRole()	Role to use for encrypting streams with KMS key.
default List<CfnTag>	getTags()	Tags assigned to the mission profile.
String	getTrackingConfigArn()	The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataflowEdges

@Stability(Stable)
@NotNull
Object getDataflowEdges()

A list containing lists of config ARNs.

Each list of config ARNs is an edge, with a "from" config and a "to" config.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-dataflowedges

getMinimumViableContactDurationSeconds

@Stability(Stable)
@NotNull
Number getMinimumViableContactDurationSeconds()

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

Ground Station will not return contacts shorter than this duration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-minimumviablecontactdurationseconds

getName

@Stability(Stable)
@NotNull
String getName()

The name of the mission profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-name

getTrackingConfigArn

@Stability(Stable)
@NotNull
String getTrackingConfigArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-trackingconfigarn

getContactPostPassDurationSeconds

@Stability(Stable)
@Nullable
default Number 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-contactpostpassdurationseconds

getContactPrePassDurationSeconds

@Stability(Stable)
@Nullable
default Number 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-contactprepassdurationseconds

getStreamsKmsKey

@Stability(Stable)
@Nullable
default Object getStreamsKmsKey()

KMS key to use for encrypting streams.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-streamskmskey

getStreamsKmsRole

@Stability(Stable)
@Nullable
default String getStreamsKmsRole()

Role to use for encrypting streams with KMS key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-streamskmsrole

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags assigned to the mission profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-tags

builder

@Stability(Stable)
static CfnMissionProfileProps.Builder builder()

Returns:

a CfnMissionProfileProps.Builder of CfnMissionProfileProps