Skip to content
v2.277.0

HostSharedAlbConfigurationProperty Struct ​

The host shared ALB configuration for the gateway.

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 hostSharedAlbConfigurationProperty: ecs.CfnGateway.HostSharedAlbConfigurationProperty = {
  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

host_shared_alb_configuration_property = 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.*;

HostSharedAlbConfigurationProperty hostSharedAlbConfigurationProperty = 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();
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 hostSharedAlbConfigurationProperty = 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"

hostSharedAlbConfigurationProperty := &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 ​

accessLogsoptionalIResolvable | CfnGateway.GatewayElbAccessLogConfigurationPropertyaccess_logsoptionaltyping.Union[IResolvable, GatewayElbAccessLogConfigurationProperty]accessLogsoptionalIResolvableAccessLogsoptionalIResolvableAccessLogsoptionalinterface{}#
The access log configuration for the gateway ALB.

Access logging is enabled by the presence of a destination.

currentAlbCountoptionalnumbercurrent_alb_countoptionalint | floatcurrentAlbCountoptionalNumberCurrentAlbCountoptionaldoubleCurrentAlbCountoptional*float64#
The current number of ALBs provisioned for the gateway.
httpDesyncoptionalstringhttp_desyncoptionalstrhttpDesyncoptionalStringHttpDesyncoptionalstringHttpDesyncoptional*string#
The HTTP desync mitigation mode for the ALB.
maxAlbCountoptionalnumbermax_alb_countoptionalint | floatmaxAlbCountoptionalNumberMaxAlbCountoptionaldoubleMaxAlbCountoptional*float64#
The maximum number of ALBs to provision for the gateway.
networkConfigurationoptionalIResolvable | CfnGateway.GatewayElbNetworkConfigurationPropertynetwork_configurationoptionaltyping.Union[IResolvable, GatewayElbNetworkConfigurationProperty]networkConfigurationoptionalIResolvableNetworkConfigurationoptionalIResolvableNetworkConfigurationoptionalinterface{}#
The network configuration for the gateway ALB.
portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64#
The port on which the ALB listens.
protocoloptionalstringprotocoloptionalstrprotocoloptionalStringProtocoloptionalstringProtocoloptional*string#
The protocol for the ALB listener.
schemeoptionalstringschemeoptionalstrschemeoptionalStringSchemeoptionalstringSchemeoptional*string#
The scheme for the ALB.
testTrafficRulesoptionalIResolvable | CfnGateway.GatewayAlbTestTrafficRulesPropertytest_traffic_rulesoptionaltyping.Union[IResolvable, GatewayAlbTestTrafficRulesProperty]testTrafficRulesoptionalIResolvableTestTrafficRulesoptionalIResolvableTestTrafficRulesoptionalinterface{}#
The test traffic rules for the gateway ALB.
webAclArnoptionalstringweb_acl_arnoptionalstrwebAclArnoptionalStringWebAclArnoptionalstringWebAclArnoptional*string#
The ARN of the WAFv2 web ACL to associate with the ALB.