Skip to content
v2.277.0

LoadBalancerListenerContextQuery Struct ​

Query input for looking up a load balancer listener.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';

declare const assumeRoleAdditionalOptions: any;
const loadBalancerListenerContextQuery: cloud_assembly_schema.LoadBalancerListenerContextQuery = {
  account: 'account',
  loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,
  region: 'region',

  // the properties below are optional
  assumeRoleAdditionalOptions: {
    assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
  },
  listenerArn: 'listenerArn',
  listenerPort: 123,
  listenerProtocol: cloud_assembly_schema.LoadBalancerListenerProtocol.HTTP,
  loadBalancerArn: 'loadBalancerArn',
  loadBalancerTags: [{
    key: 'key',
    value: 'value',
  }],
  lookupRoleArn: 'lookupRoleArn',
  lookupRoleExternalId: 'lookupRoleExternalId',
};
python
from aws_cdk.cloud_assembly_schema import LoadBalancerListenerContextQuery, Tag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import cloud_assembly_schema

# assume_role_additional_options: Any

load_balancer_listener_context_query = LoadBalancerListenerContextQuery(
    account="account",
    load_balancer_type=cloud_assembly_schema.LoadBalancerType.NETWORK,
    region="region",

    # the properties below are optional
    assume_role_additional_options={
        "assume_role_additional_options_key": assume_role_additional_options
    },
    listener_arn="listenerArn",
    listener_port=123,
    listener_protocol=cloud_assembly_schema.LoadBalancerListenerProtocol.HTTP,
    load_balancer_arn="loadBalancerArn",
    load_balancer_tags=[Tag(
        key="key",
        value="value"
    )],
    lookup_role_arn="lookupRoleArn",
    lookup_role_external_id="lookupRoleExternalId"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloud_assembly_schema.*;

Object assumeRoleAdditionalOptions;

LoadBalancerListenerContextQuery loadBalancerListenerContextQuery = LoadBalancerListenerContextQuery.builder()
        .account("account")
        .loadBalancerType(LoadBalancerType.NETWORK)
        .region("region")

        // the properties below are optional
        .assumeRoleAdditionalOptions(Map.of(
                "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
        .listenerArn("listenerArn")
        .listenerPort(123)
        .listenerProtocol(LoadBalancerListenerProtocol.HTTP)
        .loadBalancerArn("loadBalancerArn")
        .loadBalancerTags(List.of(Tag.builder()
                .key("key")
                .value("value")
                .build()))
        .lookupRoleArn("lookupRoleArn")
        .lookupRoleExternalId("lookupRoleExternalId")
        .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.Cloud_assembly_schema;

var assumeRoleAdditionalOptions;

var loadBalancerListenerContextQuery = new LoadBalancerListenerContextQuery {
    Account = "account",
    LoadBalancerType = LoadBalancerType.NETWORK,
    Region = "region",

    // the properties below are optional
    AssumeRoleAdditionalOptions = new Dictionary<string, object> {
        { "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions }
    },
    ListenerArn = "listenerArn",
    ListenerPort = 123,
    ListenerProtocol = LoadBalancerListenerProtocol.HTTP,
    LoadBalancerArn = "loadBalancerArn",
    LoadBalancerTags = new [] { new Tag {
        Key = "key",
        Value = "value"
    } },
    LookupRoleArn = "lookupRoleArn",
    LookupRoleExternalId = "lookupRoleExternalId"
};
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"

var assumeRoleAdditionalOptions interface{}

loadBalancerListenerContextQuery := &LoadBalancerListenerContextQuery{
	Account: jsii.String("account"),
	LoadBalancerType: awscdk.Cloud_assembly_schema.LoadBalancerType_NETWORK,
	Region: jsii.String("region"),

	// the properties below are optional
	AssumeRoleAdditionalOptions: map[string]interface{}{
		"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
	},
	ListenerArn: jsii.String("listenerArn"),
	ListenerPort: jsii.Number(123),
	ListenerProtocol: awscdk.*Cloud_assembly_schema.LoadBalancerListenerProtocol_HTTP,
	LoadBalancerArn: jsii.String("loadBalancerArn"),
	LoadBalancerTags: []Tag{
		&Tag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	LookupRoleArn: jsii.String("lookupRoleArn"),
	LookupRoleExternalId: jsii.String("lookupRoleExternalId"),
}

Properties ​

accountstringaccountstraccountStringAccountstringAccount*string required #
Query account.
assumeRoleAdditionalOptionsoptional{ [key: string]: any }assume_role_additional_optionsoptionaltyping.Mapping[str, Any]assumeRoleAdditionalOptionsoptionalMap<String, Object>AssumeRoleAdditionalOptionsoptionalIDictionary<string, object>AssumeRoleAdditionalOptionsoptional*map[string]interface{} #
Additional options to pass to STS when assuming the lookup role.

Default: No additional options.

  • RoleArn should not be used. Use the dedicated lookupRoleArn property instead.
  • ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.
listenerArnoptionalstringlistener_arnoptionalstrlistenerArnoptionalStringListenerArnoptionalstringListenerArnoptional*string #
Find by listener's arn.

Default: does not find by listener arn

listenerPortoptionalnumberlistener_portoptionalint | floatlistenerPortoptionalNumberListenerPortoptionaldoubleListenerPortoptional*float64 #
Filter listeners by listener port.

Default: does not filter by a listener port

listenerProtocoloptionalLoadBalancerListenerProtocollistener_protocoloptionalLoadBalancerListenerProtocollistenerProtocoloptionalLoadBalancerListenerProtocolListenerProtocoloptionalLoadBalancerListenerProtocolListenerProtocoloptionalLoadBalancerListenerProtocol #
Filter by listener protocol.

Default: does not filter by listener protocol

loadBalancerArnoptionalstringload_balancer_arnoptionalstrloadBalancerArnoptionalStringLoadBalancerArnoptionalstringLoadBalancerArnoptional*string #
Find by load balancer's ARN.

Default: does not search by load balancer arn

loadBalancerTagsoptionalTag[]load_balancer_tagsoptionaltyping.List[Tag]loadBalancerTagsoptionalList<Tag>LoadBalancerTagsoptionalTag[]LoadBalancerTagsoptional*[]Tag #
Match load balancer tags.

Default: does not match load balancers by tags

loadBalancerTypeLoadBalancerTypeload_balancer_typeLoadBalancerTypeloadBalancerTypeLoadBalancerTypeLoadBalancerTypeLoadBalancerTypeLoadBalancerTypeLoadBalancerType required #
Filter load balancers by their type.
lookupRoleArnoptionalstringlookup_role_arnoptionalstrlookupRoleArnoptionalStringLookupRoleArnoptionalstringLookupRoleArnoptional*string = None #
The ARN of the role that should be used to look up the missing values.
lookupRoleExternalIdoptionalstringlookup_role_external_idoptionalstrlookupRoleExternalIdoptionalStringLookupRoleExternalIdoptionalstringLookupRoleExternalIdoptional*string #
The ExternalId that needs to be supplied while assuming this role.

Default: No ExternalId will be supplied

regionstringregionstrregionStringRegionstringRegion*string required #
Query region.