Skip to content
v2.277.0

GatewayConfigurationProperty Struct ​

The configuration for the gateway.

Currently only supports hostSharedAlb.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const gatewayConfigurationProperty: ecs.CfnGateway.GatewayConfigurationProperty = {
  hostSharedAlb: {
    accessLogs: {
      destination: {
        s3: {
          bucket: 'bucket',

          // the properties below are optional
          prefix: 'prefix',
        },
      },
    },
    currentAlbCount: 123,
    httpDesync: 'httpDesync',
    maxAlbCount: 123,
    networkConfiguration: {
      inboundSecurityGroup: 'inboundSecurityGroup',
      ipAddressType: 'ipAddressType',
      subnets: ['subnets'],
    },
    port: 123,
    protocol: 'protocol',
    scheme: 'scheme',
    testTrafficRules: {
      header: {
        name: 'name',
        values: ['values'],
      },
    },
    webAclArn: 'webAclArn',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ecs as ecs

gateway_configuration_property = ecs.CfnGateway.GatewayConfigurationProperty(
    host_shared_alb=ecs.CfnGateway.HostSharedAlbConfigurationProperty(
        access_logs=ecs.CfnGateway.GatewayElbAccessLogConfigurationProperty(
            destination=ecs.CfnGateway.GatewayElbAccessLogDestinationProperty(
                s3=ecs.CfnGateway.GatewayElbAccessLogS3DestinationProperty(
                    bucket="bucket",

                    # the properties below are optional
                    prefix="prefix"
                )
            )
        ),
        current_alb_count=123,
        http_desync="httpDesync",
        max_alb_count=123,
        network_configuration=ecs.CfnGateway.GatewayElbNetworkConfigurationProperty(
            inbound_security_group="inboundSecurityGroup",
            ip_address_type="ipAddressType",
            subnets=["subnets"]
        ),
        port=123,
        protocol="protocol",
        scheme="scheme",
        test_traffic_rules=ecs.CfnGateway.GatewayAlbTestTrafficRulesProperty(
            header=ecs.CfnGateway.GatewayTestTrafficHeaderProperty(
                name="name",
                values=["values"]
            )
        ),
        web_acl_arn="webAclArn"
    )
)
java
// 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.*;

GatewayConfigurationProperty gatewayConfigurationProperty = GatewayConfigurationProperty.builder()
        .hostSharedAlb(HostSharedAlbConfigurationProperty.builder()
                .accessLogs(GatewayElbAccessLogConfigurationProperty.builder()
                        .destination(GatewayElbAccessLogDestinationProperty.builder()
                                .s3(GatewayElbAccessLogS3DestinationProperty.builder()
                                        .bucket("bucket")

                                        // the properties below are optional
                                        .prefix("prefix")
                                        .build())
                                .build())
                        .build())
                .currentAlbCount(123)
                .httpDesync("httpDesync")
                .maxAlbCount(123)
                .networkConfiguration(GatewayElbNetworkConfigurationProperty.builder()
                        .inboundSecurityGroup("inboundSecurityGroup")
                        .ipAddressType("ipAddressType")
                        .subnets(List.of("subnets"))
                        .build())
                .port(123)
                .protocol("protocol")
                .scheme("scheme")
                .testTrafficRules(GatewayAlbTestTrafficRulesProperty.builder()
                        .header(GatewayTestTrafficHeaderProperty.builder()
                                .name("name")
                                .values(List.of("values"))
                                .build())
                        .build())
                .webAclArn("webAclArn")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;

var gatewayConfigurationProperty = new GatewayConfigurationProperty {
    HostSharedAlb = new HostSharedAlbConfigurationProperty {
        AccessLogs = new GatewayElbAccessLogConfigurationProperty {
            Destination = new GatewayElbAccessLogDestinationProperty {
                S3 = new GatewayElbAccessLogS3DestinationProperty {
                    Bucket = "bucket",

                    // the properties below are optional
                    Prefix = "prefix"
                }
            }
        },
        CurrentAlbCount = 123,
        HttpDesync = "httpDesync",
        MaxAlbCount = 123,
        NetworkConfiguration = new GatewayElbNetworkConfigurationProperty {
            InboundSecurityGroup = "inboundSecurityGroup",
            IpAddressType = "ipAddressType",
            Subnets = new [] { "subnets" }
        },
        Port = 123,
        Protocol = "protocol",
        Scheme = "scheme",
        TestTrafficRules = new GatewayAlbTestTrafficRulesProperty {
            Header = new GatewayTestTrafficHeaderProperty {
                Name = "name",
                Values = new [] { "values" }
            }
        },
        WebAclArn = "webAclArn"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

gatewayConfigurationProperty := &GatewayConfigurationProperty{
	HostSharedAlb: &HostSharedAlbConfigurationProperty{
		AccessLogs: &GatewayElbAccessLogConfigurationProperty{
			Destination: &GatewayElbAccessLogDestinationProperty{
				S3: &GatewayElbAccessLogS3DestinationProperty{
					Bucket: jsii.String("bucket"),

					// the properties below are optional
					Prefix: jsii.String("prefix"),
				},
			},
		},
		CurrentAlbCount: jsii.Number(123),
		HttpDesync: jsii.String("httpDesync"),
		MaxAlbCount: jsii.Number(123),
		NetworkConfiguration: &GatewayElbNetworkConfigurationProperty{
			InboundSecurityGroup: jsii.String("inboundSecurityGroup"),
			IpAddressType: jsii.String("ipAddressType"),
			Subnets: []*string{
				jsii.String("subnets"),
			},
		},
		Port: jsii.Number(123),
		Protocol: jsii.String("protocol"),
		Scheme: jsii.String("scheme"),
		TestTrafficRules: &GatewayAlbTestTrafficRulesProperty{
			Header: &GatewayTestTrafficHeaderProperty{
				Name: jsii.String("name"),
				Values: []*string{
					jsii.String("values"),
				},
			},
		},
		WebAclArn: jsii.String("webAclArn"),
	},
}

Properties ​

hostSharedAlbIResolvable | CfnGateway.HostSharedAlbConfigurationPropertyhost_shared_albtyping.Union[IResolvable, HostSharedAlbConfigurationProperty]hostSharedAlbIResolvableHostSharedAlbIResolvableHostSharedAlbinterface{}required#
The host shared ALB configuration for the gateway.