Skip to content
v2.274.0

LoadBalancerFilter Struct ​

Filters for selecting load balancers.

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 loadBalancerFilter: cloud_assembly_schema.LoadBalancerFilter = {
  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.
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.
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_typeLoadBalancerTypeloadBalancerTypeLoadBalancerTypeLoadBalancerTypeLoadBalancerTypeLoadBalancerTypeLoadBalancerTyperequired#
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*stringrequired#
Query region.