Skip to content
v2.273.0

LoadBalancerContextQuery Struct ​

Query input for looking up a load balancer.

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 loadBalancerContextQuery: cloud_assembly_schema.LoadBalancerContextQuery = {
  account: 'account',
  loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,
  region: 'region',

  // the properties below are optional
  assumeRoleAdditionalOptions: {
    assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
  },
  loadBalancerArn: 'loadBalancerArn',
  loadBalancerTags: [{
    key: 'key',
    value: 'value',
  }],
  lookupRoleArn: 'lookupRoleArn',
  lookupRoleExternalId: 'lookupRoleExternalId',
};

Properties ​

accountstringaccountstraccountStringAccountstringAccount*stringrequired#
Query account.
assumeRoleAdditionalOptions{ [key: string]: any }assume_role_additional_optionstyping.Mapping[str, Any]assumeRoleAdditionalOptionsMap<String, Object>AssumeRoleAdditionalOptionsIDictionary<string, object>AssumeRoleAdditionalOptions*map[string]interface{}= No additional options.#
Additional options to pass to STS when assuming the lookup role.
  • RoleArn should not be used. Use the dedicated lookupRoleArn property instead.
  • ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.
loadBalancerArnstringload_balancer_arnstrloadBalancerArnStringLoadBalancerArnstringLoadBalancerArn*string= does not search by load balancer…#
Find by load balancer's ARN.
default

Default: does not search by load balancer arn

loadBalancerTagsTag[]load_balancer_tagstyping.List[Tag]loadBalancerTagsList<Tag>LoadBalancerTagsTag[]LoadBalancerTags*[]Tag= does not match load balancers by…#
Match load balancer tags.
default

Default: does not match load balancers by tags

loadBalancerTypeLoadBalancerTypeload_balancer_typeLoadBalancerTypeloadBalancerTypeLoadBalancerTypeLoadBalancerTypeLoadBalancerTypeLoadBalancerTypeLoadBalancerTyperequired#
Filter load balancers by their type.
lookupRoleArnstringlookup_role_arnstrlookupRoleArnStringLookupRoleArnstringLookupRoleArn*string= None#
The ARN of the role that should be used to look up the missing values.
lookupRoleExternalIdstringlookup_role_external_idstrlookupRoleExternalIdStringLookupRoleExternalIdstringLookupRoleExternalId*string= No ExternalId will be supplied#
The ExternalId that needs to be supplied while assuming this role.
regionstringregionstrregionStringRegionstringRegion*stringrequired#
Query region.