interface LoadBalancerFilter

Language	Type name
.NET	Amazon.CDK.cloud_assembly_schema.LoadBalancerFilter
Go	github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#LoadBalancerFilter
Java	software.amazon.awscdk.cloud_assembly_schema.LoadBalancerFilter
Python	aws_cdk.cloud_assembly_schema.LoadBalancerFilter
TypeScript (source)	aws-cdk-lib » cloud_assembly_schema » LoadBalancerFilter

Filters for selecting load balancers.

Example

// 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

Name	Type	Description
account	string	Query account.
loadBalancerType	LoadBalancerType	Filter load balancers by their type.
region	string	Query region.
assumeRoleAdditionalOptions?	{ [string]: any }	Additional options to pass to STS when assuming the lookup role.
loadBalancerArn?	string	Find by load balancer's ARN.
loadBalancerTags?	Tag[]	Match load balancer tags.
lookupRoleArn?	string	The ARN of the role that should be used to look up the missing values.
lookupRoleExternalId?	string	The ExternalId that needs to be supplied while assuming this role.

---

account

Type: string

Query account.

---

loadBalancerType

Type: LoadBalancerType

Filter load balancers by their type.

---

region

Type: string

Query region.

---

assumeRoleAdditionalOptions?

Type: { [string]: any } (optional, default: 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.

See also: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

---

loadBalancerArn?

Type: string (optional, default: does not search by load balancer arn)

Find by load balancer's ARN.

---

loadBalancerTags?

Type: Tag[] (optional, default: does not match load balancers by tags)

Match load balancer tags.

---

lookupRoleArn?

Type: string (optional, default: None)

The ARN of the role that should be used to look up the missing values.

---

lookupRoleExternalId?

Type: string (optional, default: No ExternalId will be supplied)

The ExternalId that needs to be supplied while assuming this role.