AWS cli medium security documentation change
Summary
Added documentation for uplinkAwsGroundStationAgentEndpoint and downlinkAwsGroundStationAgentEndpoint structures with detailed connection parameters, validation constraints, and health monitoring fields. Updated minimum values for port constraints from 120 to 30.
Security assessment
Added strict input validation patterns (IP address regex, port ranges 30-...) and MTU size constraints (1400-1500 bytes) to prevent misconfigurations. Introduced security monitoring through 'auditResults' (HEALTHY/UNHEALTHY) and 'agentStatus' fields. These changes help enforce secure network configurations and provide visibility into endpoint health, reducing attack surface from invalid inputs.
Diff
diff --git a/cli/latest/reference/groundstation/create-dataflow-endpoint-group.md b/cli/latest/reference/groundstation/create-dataflow-endpoint-group.md index 83abab6e0..8312e2391 100644 --- a//cli/latest/reference/groundstation/create-dataflow-endpoint-group.md +++ b//cli/latest/reference/groundstation/create-dataflow-endpoint-group.md @@ -13 +13 @@ - * [next](create-ephemeris.html "create-ephemeris") | + * [next](create-dataflow-endpoint-group-v2.html "create-dataflow-endpoint-group-v2") | @@ -15 +15 @@ - * [AWS CLI 2.31.28 Command Reference](../../index.html) » + * [AWS CLI 2.31.31 Command Reference](../../index.html) » @@ -23 +23 @@ - * [create-ephemeris →](create-ephemeris.html "next chapter \(use the right arrow\)") + * [create-dataflow-endpoint-group-v2 →](create-dataflow-endpoint-group-v2.html "next chapter \(use the right arrow\)") @@ -288,0 +289,230 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ground +>> +>> uplinkAwsGroundStationAgentEndpoint -> (structure) +>> +>>> Definition for an uplink agent endpoint +>>> +>>> name -> (string) [required] +>>> +>>>> Uplink dataflow endpoint name +>>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `256` +>>>> * pattern: `[ a-zA-Z0-9_:-]{1,256}` +>>>> + +>>> +>>> dataflowDetails -> (tagged union structure) [required] +>>> +>>>> Dataflow details for the uplink endpoint +>>>> +>>>> ### Note +>>>> +>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `agentConnectionDetails`. +>>>> +>>>> agentConnectionDetails -> (structure) +>>>> +>>>>> Uplink connection details for customer to Agent and Agent to Ground Station +>>>>> +>>>>> ingressAddressAndPort -> (structure) [required] +>>>>> +>>>>>> Egress address of AgentEndpoint with an optional mtu. +>>>>>> +>>>>>> socketAddress -> (structure) [required] +>>>>>> +>>>>>>> A socket address. +>>>>>>> +>>>>>>> name -> (string) [required] +>>>>>>> +>>>>>>>> Name of a socket address. +>>>>>>> +>>>>>>> port -> (integer) [required] +>>>>>>> +>>>>>>>> Port of a socket address. +>>>>>> +>>>>>> mtu -> (integer) +>>>>>> +>>>>>>> Maximum transmission unit (MTU) size in bytes of a dataflow endpoint. +>>>>> +>>>>> agentIpAndPortAddress -> (structure) [required] +>>>>> +>>>>>> Ingress address of AgentEndpoint with a port range and an optional mtu. +>>>>>> +>>>>>> socketAddress -> (structure) [required] +>>>>>> +>>>>>>> A ranged socket address. +>>>>>>> +>>>>>>> name -> (string) [required] +>>>>>>> +>>>>>>>> IPv4 socket address. +>>>>>>>> +>>>>>>>> Constraints: +>>>>>>>> +>>>>>>>> * min: `7` +>>>>>>>> * max: `16` +>>>>>>>> * pattern: `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}` +>>>>>>>> + +>>>>>>> +>>>>>>> portRange -> (structure) [required] +>>>>>>> +>>>>>>>> Port range of a socket address. +>>>>>>>> +>>>>>>>> minimum -> (integer) [required] +>>>>>>>> +>>>>>>>>> A minimum value. +>>>>>>>> +>>>>>>>> maximum -> (integer) [required] +>>>>>>>> +>>>>>>>>> A maximum value. +>>>>>> +>>>>>> mtu -> (integer) +>>>>>> +>>>>>>> Maximum transmission unit (MTU) size in bytes of a dataflow endpoint. +>>>>>>> +>>>>>>> Constraints: +>>>>>>> +>>>>>>> * min: `1400` +>>>>>>> * max: `1500` +>>>>>>> + +>>> +>>> agentStatus -> (string) +>>> +>>>> Status of the agent associated with the uplink dataflow endpoint +>>>> +>>>> Possible values: +>>>> +>>>> * `SUCCESS` +>>>> * `FAILED` +>>>> * `ACTIVE` +>>>> * `INACTIVE` +>>>> + +>>> +>>> auditResults -> (string) +>>> +>>>> Health audit results for the uplink dataflow endpoint +>>>> +>>>> Possible values: +>>>> +>>>> * `HEALTHY` +>>>> * `UNHEALTHY` +>>>> + +>> +>> downlinkAwsGroundStationAgentEndpoint -> (structure) +>> +>>> Definition for a downlink agent endpoint +>>> +>>> name -> (string) [required] +>>> +>>>> Downlink dataflow endpoint name +>>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `256` +>>>> * pattern: `[ a-zA-Z0-9_:-]{1,256}` +>>>> + +>>> +>>> dataflowDetails -> (tagged union structure) [required] +>>> +>>>> Dataflow details for the downlink endpoint +>>>> +>>>> ### Note +>>>> +>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `agentConnectionDetails`. +>>>> +>>>> agentConnectionDetails -> (structure) +>>>> +>>>>> Downlink connection details for customer to Agent and Agent to Ground Station +>>>>> +>>>>> agentIpAndPortAddress -> (structure) [required] +>>>>> +>>>>>> Ingress address of AgentEndpoint with a port range and an optional mtu. +>>>>>> +>>>>>> socketAddress -> (structure) [required] +>>>>>> +>>>>>>> A ranged socket address. +>>>>>>> +>>>>>>> name -> (string) [required] +>>>>>>> +>>>>>>>> IPv4 socket address. +>>>>>>>> +>>>>>>>> Constraints: +>>>>>>>> +>>>>>>>> * min: `7` +>>>>>>>> * max: `16` +>>>>>>>> * pattern: `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}` +>>>>>>>> + +>>>>>>> +>>>>>>> portRange -> (structure) [required] +>>>>>>> +>>>>>>>> Port range of a socket address. +>>>>>>>> +>>>>>>>> minimum -> (integer) [required] +>>>>>>>> +>>>>>>>>> A minimum value. +>>>>>>>> +>>>>>>>> maximum -> (integer) [required] +>>>>>>>> +>>>>>>>>> A maximum value. +>>>>>> +>>>>>> mtu -> (integer) +>>>>>> +>>>>>>> Maximum transmission unit (MTU) size in bytes of a dataflow endpoint. +>>>>>>> +>>>>>>> Constraints: +>>>>>>> +>>>>>>> * min: `1400` +>>>>>>> * max: `1500` +>>>>>>> +