Package software.amazon.awscdk.services.ecs

Interface CfnService.TimeoutConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.TimeoutConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.TimeoutConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

An object that represents the timeout configurations for Service Connect.

If idleTimeout is set to a time that is less than perRequestTimeout , the connection will close when the idleTimeout is reached and not the perRequestTimeout .

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.ecs.*;
 TimeoutConfigurationProperty timeoutConfigurationProperty = TimeoutConfigurationProperty.builder()
         .idleTimeoutSeconds(123)
         .perRequestTimeoutSeconds(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-timeoutconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnService.TimeoutConfigurationProperty.Builder	A builder for CfnService.TimeoutConfigurationProperty
static final class	CfnService.TimeoutConfigurationProperty.Jsii$Proxy	An implementation for CfnService.TimeoutConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnService.TimeoutConfigurationProperty.Builder	builder()
default Number	getIdleTimeoutSeconds()	The amount of time in seconds a connection will stay active while idle.
default Number	getPerRequestTimeoutSeconds()	The amount of time waiting for the upstream to respond with a complete response per request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdleTimeoutSeconds

@Stability(Stable)
@Nullable
default Number getIdleTimeoutSeconds()

The amount of time in seconds a connection will stay active while idle.

A value of 0 can be set to disable idleTimeout .

The idleTimeout default for HTTP / HTTP2 / GRPC is 5 minutes.

The idleTimeout default for TCP is 1 hour.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-timeoutconfiguration.html#cfn-ecs-service-timeoutconfiguration-idletimeoutseconds

getPerRequestTimeoutSeconds

@Stability(Stable)
@Nullable
default Number getPerRequestTimeoutSeconds()

The amount of time waiting for the upstream to respond with a complete response per request.

A value of 0 can be set to disable perRequestTimeout . perRequestTimeout can only be set if Service Connect appProtocol isn't TCP . Only idleTimeout is allowed for TCP appProtocol .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-timeoutconfiguration.html#cfn-ecs-service-timeoutconfiguration-perrequesttimeoutseconds

builder

@Stability(Stable)
static CfnService.TimeoutConfigurationProperty.Builder builder()

Returns:

a CfnService.TimeoutConfigurationProperty.Builder of CfnService.TimeoutConfigurationProperty