Package 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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:08.024Z") @Stability(Stable) public class CfnDataflowEndpointGroup extends CfnResource implements IInspectable, ITaggable
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()
                 .awsGroundStationAgentEndpoint(AwsGroundStationAgentEndpointProperty.builder()
                         .agentStatus("agentStatus")
                         .auditResults("auditResults")
                         .egressAddress(ConnectionDetailsProperty.builder()
                                 .mtu(123)
                                 .socketAddress(SocketAddressProperty.builder()
                                         .name("name")
                                         .port(123)
                                         .build())
                                 .build())
                         .ingressAddress(RangedConnectionDetailsProperty.builder()
                                 .mtu(123)
                                 .socketAddress(RangedSocketAddressProperty.builder()
                                         .name("name")
                                         .portRange(IntegerRangeProperty.builder()
                                                 .maximum(123)
                                                 .minimum(123)
                                                 .build())
                                         .build())
                                 .build())
                         .name("name")
                         .build())
                 .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
         .contactPostPassDurationSeconds(123)
         .contactPrePassDurationSeconds(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataflowEndpointGroup

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

    • CfnDataflowEndpointGroup

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

    • CfnDataflowEndpointGroup

      @Stability(Stable) public CfnDataflowEndpointGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataflowEndpointGroupProps props)
      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

    • inspect

      @Stability(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(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(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(Stable) @NotNull public String getAttrId()
      UUID of a dataflow endpoint group.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getEndpointDetails

      @Stability(Stable) @NotNull public Object getEndpointDetails()
      List of Endpoint Details, containing address and port for each endpoint.

    • setEndpointDetails

      @Stability(Stable) public void setEndpointDetails(@NotNull IResolvable value)
      List of Endpoint Details, containing address and port for each endpoint.

    • setEndpointDetails

      @Stability(Stable) public void setEndpointDetails(@NotNull List<Object> value)
      List of Endpoint Details, containing address and port for each endpoint.

    • getContactPostPassDurationSeconds

      @Stability(Stable) @Nullable public Number getContactPostPassDurationSeconds()
      Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state.

    • setContactPostPassDurationSeconds

      @Stability(Stable) public void setContactPostPassDurationSeconds(@Nullable Number value)
      Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state.

    • getContactPrePassDurationSeconds

      @Stability(Stable) @Nullable public Number getContactPrePassDurationSeconds()
      Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state.

    • setContactPrePassDurationSeconds

      @Stability(Stable) public void setContactPrePassDurationSeconds(@Nullable Number value)
      Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Tags assigned to a resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Tags assigned to a resource.