software.amazon.awscdk.services.groundstation

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.681Z")
 @Stability(value=Stable)
public class CfnMissionProfile
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GroundStation::MissionProfile`.

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)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMissionProfile.Builder A fluent builder for CfnMissionProfile.
static interface	CfnMissionProfile.DataflowEdgeProperty A dataflow edge defines from where and to where data will flow during a contact.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMissionProfile(software.constructs.Construct scope, String id, CfnMissionProfileProps props) Create a new `AWS::GroundStation::MissionProfile`.
protected	CfnMissionProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMissionProfile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the mission profile, such as `arn:aws:groundstation:us-east-2:1234567890:mission-profile/9940bf3b-d2ba-427e-9906-842b5e5d2296` .
String	getAttrId() The ID of the mission profile, such as `9940bf3b-d2ba-427e-9906-842b5e5d2296` .
String	getAttrRegion() The region of the mission profile.
protected Map<String,Object>	getCfnProperties()
Number	getContactPostPassDurationSeconds() Amount of time in seconds after a contact ends that you’d like to receive a CloudWatch Event indicating the pass has finished.
Number	getContactPrePassDurationSeconds() Amount of time in seconds prior to contact start that you'd like to receive a CloudWatch 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.
TagManager	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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContactPostPassDurationSeconds(Number value) Amount of time in seconds after a contact ends that you’d like to receive a CloudWatch Event indicating the pass has finished.
void	setContactPrePassDurationSeconds(Number value) Amount of time in seconds prior to contact start that you'd like to receive a CloudWatch Event indicating an upcoming pass.
void	setDataflowEdges(IResolvable value) A list containing lists of config ARNs.
void	setDataflowEdges(List<Object> value) A list containing lists of config ARNs.
void	setMinimumViableContactDurationSeconds(Number value) Minimum length of a contact in seconds that Ground Station will return when listing contacts.
void	setName(String value) The name of 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, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMissionProfile

protected CfnMissionProfile(software.amazon.jsii.JsiiObjectRef objRef)

CfnMissionProfile

protected CfnMissionProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMissionProfile

@Stability(value=Stable)
public CfnMissionProfile(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnMissionProfileProps props)

Create a new `AWS::GroundStation::MissionProfile`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

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

getAttrRegion

@Stability(value=Stable)
 @NotNull
public String getAttrRegion()

The region of the mission profile.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Tags assigned to the mission profile.

getDataflowEdges

@Stability(value=Stable)
 @NotNull
public 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.

setDataflowEdges

@Stability(value=Stable)
public void setDataflowEdges(@NotNull
                                                      IResolvable value)

A list containing lists of config ARNs.

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

setDataflowEdges

@Stability(value=Stable)
public void setDataflowEdges(@NotNull
                                                      List<Object> value)

A list containing lists of config ARNs.

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

getMinimumViableContactDurationSeconds

@Stability(value=Stable)
 @NotNull
public 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.

setMinimumViableContactDurationSeconds

@Stability(value=Stable)
public void setMinimumViableContactDurationSeconds(@NotNull
                                                                            Number value)

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.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the mission profile.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the mission profile.

getTrackingConfigArn

@Stability(value=Stable)
 @NotNull
public String getTrackingConfigArn()

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

setTrackingConfigArn

@Stability(value=Stable)
public void setTrackingConfigArn(@NotNull
                                                          String value)

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

getContactPostPassDurationSeconds

@Stability(value=Stable)
 @Nullable
public Number getContactPostPassDurationSeconds()

Amount of time in seconds after a contact ends that you’d like to receive a CloudWatch Event indicating the pass has finished.

For more information on CloudWatch Events, see the What Is CloudWatch Events?

setContactPostPassDurationSeconds

@Stability(value=Stable)
public void setContactPostPassDurationSeconds(@Nullable
                                                                       Number value)

Amount of time in seconds after a contact ends that you’d like to receive a CloudWatch Event indicating the pass has finished.

For more information on CloudWatch Events, see the What Is CloudWatch Events?

getContactPrePassDurationSeconds

@Stability(value=Stable)
 @Nullable
public Number getContactPrePassDurationSeconds()

Amount of time in seconds prior to contact start that you'd like to receive a CloudWatch Event indicating an upcoming pass.

For more information on CloudWatch Events, see the What Is CloudWatch Events?

setContactPrePassDurationSeconds

@Stability(value=Stable)
public void setContactPrePassDurationSeconds(@Nullable
                                                                      Number value)

Amount of time in seconds prior to contact start that you'd like to receive a CloudWatch Event indicating an upcoming pass.

For more information on CloudWatch Events, see the What Is CloudWatch Events?