@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
137 lines (136 loc) • 5.04 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an AWS Lake Formation LF Tag Expression.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.lakeformation.LfTag("example", {
* key: "example",
* values: ["value"],
* });
* const exampleLfTagExpression = new aws.lakeformation.LfTagExpression("example", {
* name: "example",
* expressions: [{
* tagKey: example.key,
* tagValues: example.values,
* }],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Lake Formation LF Tag Expression using the `name,catalog_id`. For example:
*
* ```sh
* $ pulumi import aws:lakeformation/lfTagExpression:LfTagExpression example example-tag-expression,123456789012
* ```
*/
export declare class LfTagExpression extends pulumi.CustomResource {
/**
* Get an existing LfTagExpression resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LfTagExpressionState, opts?: pulumi.CustomResourceOptions): LfTagExpression;
/**
* Returns true if the given object is an instance of LfTagExpression. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is LfTagExpression;
/**
* ID of the Data Catalog. Defaults to the account ID if not specified.
*/
readonly catalogId: pulumi.Output<string>;
/**
* Description of the LF-Tag Expression.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* A list of LF-Tag conditions (key-value pairs). See expression for more details.
*
* The following arguments are optional:
*/
readonly expressions: pulumi.Output<outputs.lakeformation.LfTagExpressionExpression[] | undefined>;
/**
* Name of the LF-Tag Expression.
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Create a LfTagExpression resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: LfTagExpressionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LfTagExpression resources.
*/
export interface LfTagExpressionState {
/**
* ID of the Data Catalog. Defaults to the account ID if not specified.
*/
catalogId?: pulumi.Input<string>;
/**
* Description of the LF-Tag Expression.
*/
description?: pulumi.Input<string>;
/**
* A list of LF-Tag conditions (key-value pairs). See expression for more details.
*
* The following arguments are optional:
*/
expressions?: pulumi.Input<pulumi.Input<inputs.lakeformation.LfTagExpressionExpression>[]>;
/**
* Name of the LF-Tag Expression.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a LfTagExpression resource.
*/
export interface LfTagExpressionArgs {
/**
* ID of the Data Catalog. Defaults to the account ID if not specified.
*/
catalogId?: pulumi.Input<string>;
/**
* Description of the LF-Tag Expression.
*/
description?: pulumi.Input<string>;
/**
* A list of LF-Tag conditions (key-value pairs). See expression for more details.
*
* The following arguments are optional:
*/
expressions?: pulumi.Input<pulumi.Input<inputs.lakeformation.LfTagExpressionExpression>[]>;
/**
* Name of the LF-Tag Expression.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}