Struct aws_sdk_gamelift::client::fluent_builders::DescribeFleetPortSettings

pub struct DescribeFleetPortSettings<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeFleetPortSettings.

Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range.

This operation can be used in the following ways:

• To retrieve the inbound connection permissions for a fleet, identify the fleet's unique identifier.

• To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.

If successful, a set of IpPermission objects is returned for the requested fleet ID. When a location is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up GameLift fleets

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

Implementations

impl<C, M, R> DescribeFleetPortSettings<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeFleetPortSettingsOutput, SdkError<DescribeFleetPortSettingsError>> where
    R::Policy: SmithyRetryPolicy<DescribeFleetPortSettingsInputOperationOutputAlias, DescribeFleetPortSettingsOutput, DescribeFleetPortSettingsError, DescribeFleetPortSettingsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn fleet_id(self, inp: impl Into<String>) -> Self

A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.

pub fn set_fleet_id(self, input: Option<String>) -> Self

A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.

pub fn location(self, inp: impl Into<String>) -> Self

A remote location to check for status of port setting updates. Use the AWS Region code format, such as us-west-2.

pub fn set_location(self, input: Option<String>) -> Self

A remote location to check for status of port setting updates. Use the AWS Region code format, such as us-west-2.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeFleetPortSettings<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.