software.amazon.awscdk.services.groundstation

Class CfnDataflowEndpointGroup

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.CfnDataflowEndpointGroup

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.679Z")
 @Stability(value=Stable)
public class CfnDataflowEndpointGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GroundStation::DataflowEndpointGroup`.

Creates a Dataflow Endpoint Group request.

Dataflow endpoint groups contain a list of endpoints. When the name of a dataflow endpoint group is specified in a mission profile, the Ground Station service will connect to the endpoints and flow data during a contact.

For more information about dataflow endpoint groups, see Dataflow Endpoint Groups .

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.*;
 CfnDataflowEndpointGroup cfnDataflowEndpointGroup = CfnDataflowEndpointGroup.Builder.create(this, "MyCfnDataflowEndpointGroup")
         .endpointDetails(List.of(EndpointDetailsProperty.builder()
                 .endpoint(DataflowEndpointProperty.builder()
                         .address(SocketAddressProperty.builder()
                                 .name("name")
                                 .port(123)
                                 .build())
                         .mtu(123)
                         .name("name")
                         .build())
                 .securityDetails(SecurityDetailsProperty.builder()
                         .roleArn("roleArn")
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnetIds(List.of("subnetIds"))
                         .build())
                 .build()))
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDataflowEndpointGroup.Builder A fluent builder for CfnDataflowEndpointGroup.
static interface	CfnDataflowEndpointGroup.DataflowEndpointProperty Contains information such as socket address and name that defines an endpoint.
static interface	CfnDataflowEndpointGroup.EndpointDetailsProperty The security details and endpoint information.
static interface	CfnDataflowEndpointGroup.SecurityDetailsProperty Information about IAM roles, subnets, and security groups needed for this DataflowEndpointGroup.
static interface	CfnDataflowEndpointGroup.SocketAddressProperty The address of the endpoint, such as `192.168.1.1` .

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
	CfnDataflowEndpointGroup(software.constructs.Construct scope, String id, CfnDataflowEndpointGroupProps props) Create a new `AWS::GroundStation::DataflowEndpointGroup`.
protected	CfnDataflowEndpointGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataflowEndpointGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the dataflow endpoint group, such as `arn:aws:groundstation:us-east-2:1234567890:dataflow-endpoint-group/9940bf3b-d2ba-427e-9906-842b5e5d2296` .
String	getAttrId() UUID of a dataflow endpoint group.
protected Map<String,Object>	getCfnProperties()
Object	getEndpointDetails() List of Endpoint Details, containing address and port for each endpoint.
TagManager	getTags() Tags assigned to a resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEndpointDetails(IResolvable value) List of Endpoint Details, containing address and port for each endpoint.
void	setEndpointDetails(List<Object> value) List of Endpoint Details, containing address and port for each endpoint.

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

CfnDataflowEndpointGroup

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

CfnDataflowEndpointGroup

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

CfnDataflowEndpointGroup

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

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

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 dataflow endpoint group, such as `arn:aws:groundstation:us-east-2:1234567890:dataflow-endpoint-group/9940bf3b-d2ba-427e-9906-842b5e5d2296` .

getAttrId

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

UUID of a dataflow endpoint group.

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 a resource.

getEndpointDetails

@Stability(value=Stable)
 @NotNull
public Object getEndpointDetails()

List of Endpoint Details, containing address and port for each endpoint.

setEndpointDetails

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

List of Endpoint Details, containing address and port for each endpoint.

setEndpointDetails

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

List of Endpoint Details, containing address and port for each endpoint.