# LoadBalancerFilter

Filters for selecting load balancers.

Extends: [ContextLookupRoleOptions](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.ContextLookupRoleOptions.html)

- Source: [`lib/cloud-assembly/context-queries.ts`](https://github.com/aws/aws-cdk-cli/blob/HEAD/packages/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/context-queries.ts)
- Type last changed: v2.160.0 · 24 Sep 2024

## Example

TypeScript:

```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',
};
```

Python:

```python
from aws_cdk.cloud_assembly_schema import LoadBalancerFilter, 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_filter = LoadBalancerFilter(
    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
    },
    load_balancer_arn="loadBalancerArn",
    load_balancer_tags=[Tag(
        key="key",
        value="value"
    )],
    lookup_role_arn="lookupRoleArn",
    lookup_role_external_id="lookupRoleExternalId"
)
```

Java:

```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;

LoadBalancerFilter loadBalancerFilter = LoadBalancerFilter.builder()
        .account("account")
        .loadBalancerType(LoadBalancerType.NETWORK)
        .region("region")

        // the properties below are optional
        .assumeRoleAdditionalOptions(Map.of(
                "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
        .loadBalancerArn("loadBalancerArn")
        .loadBalancerTags(List.of(Tag.builder()
                .key("key")
                .value("value")
                .build()))
        .lookupRoleArn("lookupRoleArn")
        .lookupRoleExternalId("lookupRoleExternalId")
        .build();
```

C# / .NET:

```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 loadBalancerFilter = new LoadBalancerFilter {
    Account = "account",
    LoadBalancerType = LoadBalancerType.NETWORK,
    Region = "region",

    // the properties below are optional
    AssumeRoleAdditionalOptions = new Dictionary<string, object> {
        { "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions }
    },
    LoadBalancerArn = "loadBalancerArn",
    LoadBalancerTags = new [] { new Tag {
        Key = "key",
        Value = "value"
    } },
    LookupRoleArn = "lookupRoleArn",
    LookupRoleExternalId = "lookupRoleExternalId"
};
```

Golang:

```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{}

loadBalancerFilter := &LoadBalancerFilter{
	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,
	},
	LoadBalancerArn: jsii.String("loadBalancerArn"),
	LoadBalancerTags: []Tag{
		&Tag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	LookupRoleArn: jsii.String("lookupRoleArn"),
	LookupRoleExternalId: jsii.String("lookupRoleExternalId"),
}
```

## Properties

- `account`: string (required) — Query account.

- `assumeRoleAdditionalOptions`: { [key: string]: any } — 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.

- `loadBalancerArn`: string — Find by load balancer's ARN.

  **Default:** does not search by load balancer arn

- `loadBalancerTags`: [Tag](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.Tag.html)[] — Match load balancer tags.

  **Default:** does not match load balancers by tags

- `loadBalancerType`: [LoadBalancerType](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.cloud_assembly_schema.LoadBalancerType.html) (required) — Filter load balancers by their type.

- `lookupRoleArn`: string = None — 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.

  **Default:** No ExternalId will be supplied

- `region`: string (required) — Query region.
