CfnMissionProfile

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.groundstation.CfnMissionProfile

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:15.597Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnMissionProfile(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The ARN of the mission profile, such as `arn:aws:groundstation:us-east-2:1234567890:mission-profile/9940bf3b-d2ba-427e-9906-842b5e5d2296` .
`java.lang.String`	`getAttrId()` The ID of the mission profile, such as `9940bf3b-d2ba-427e-9906-842b5e5d2296` .
`java.lang.String`	`getAttrRegion()` The region of the mission profile.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.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.
`java.lang.Number`	`getContactPrePassDurationSeconds()` Amount of time in seconds prior to contact start that you'd like to receive a CloudWatch Event indicating an upcoming pass.
`java.lang.Object`	`getDataflowEdges()` A list containing lists of config ARNs.
`java.lang.Number`	`getMinimumViableContactDurationSeconds()` Minimum length of a contact in seconds that Ground Station will return when listing contacts.
`java.lang.String`	`getName()` The name of the mission profile.
`TagManager`	`getTags()` Tags assigned to the mission profile.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setContactPostPassDurationSeconds(java.lang.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(java.lang.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(java.util.List<java.lang.Object> value)` A list containing lists of config ARNs.
`void`	`setMinimumViableContactDurationSeconds(java.lang.Number value)` Minimum length of a contact in seconds that Ground Station will return when listing contacts.
`void`	`setName(java.lang.String value)` The name of the mission profile.
`void`	`setTrackingConfigArn(java.lang.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.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnMissionProfile(Construct scope,
                         java.lang.String id,
                         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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.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
```
public java.lang.String getAttrId()
```
    The ID of the mission profile, such as `9940bf3b-d2ba-427e-9906-842b5e5d2296` .
  - getAttrRegion
```
public java.lang.String getAttrRegion()
```
    The region of the mission profile.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    Tags assigned to the mission profile.
  - getDataflowEdges
```
public java.lang.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
```
public void setDataflowEdges(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
```
public void setDataflowEdges(java.util.List<java.lang.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
```
public java.lang.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
```
public void setMinimumViableContactDurationSeconds(java.lang.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
```
public java.lang.String getName()
```
    The name of the mission profile.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the mission profile.
  - getTrackingConfigArn
```
public java.lang.String getTrackingConfigArn()
```
    The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact.
  - setTrackingConfigArn
```
public void setTrackingConfigArn(java.lang.String value)
```
    The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact.
  - getContactPostPassDurationSeconds
```
public java.lang.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
```
public void setContactPostPassDurationSeconds(java.lang.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
```
public java.lang.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
```
public void setContactPrePassDurationSeconds(java.lang.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?

Class CfnMissionProfile

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnMissionProfile

CfnMissionProfile

CfnMissionProfile

Method Detail

inspect

renderProperties

getAttrArn

getAttrId

getAttrRegion

getCfnProperties

getTags

getDataflowEdges

setDataflowEdges

setDataflowEdges

getMinimumViableContactDurationSeconds

setMinimumViableContactDurationSeconds

getName

setName

getTrackingConfigArn

setTrackingConfigArn

getContactPostPassDurationSeconds

setContactPostPassDurationSeconds

getContactPrePassDurationSeconds

setContactPrePassDurationSeconds