@lbrlabs/pulumi-harness
Version:
A Pulumi package for creating and managing Harness resources.
202 lines (201 loc) • 6.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for creating an AWS KMS connector.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@lbrlabs/pulumi-harness";
*
* // Credentials inherit_from_delegate
* const test = new harness.platform.AwsKmsConnector("test", {
* arnRef: "account.secret_id",
* credentials: {
* inheritFromDelegate: true,
* },
* delegateSelectors: ["harness-delegate"],
* description: "test",
* identifier: "identifer",
* region: "us-east-1",
* tags: ["foo:bar"],
* });
* ```
*
* ## Import
*
* Import account level awskms connector
*
* ```sh
* $ pulumi import harness:platform/awsKmsConnector:AwsKmsConnector example <connector_id>
* ```
*
* Import org level awskms connector
*
* ```sh
* $ pulumi import harness:platform/awsKmsConnector:AwsKmsConnector example <ord_id>/<connector_id>
* ```
*
* Import project level awskms connector
*
* ```sh
* $ pulumi import harness:platform/awsKmsConnector:AwsKmsConnector example <org_id>/<project_id>/<connector_id>
* ```
*/
export declare class AwsKmsConnector extends pulumi.CustomResource {
/**
* Get an existing AwsKmsConnector 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?: AwsKmsConnectorState, opts?: pulumi.CustomResourceOptions): AwsKmsConnector;
/**
* Returns true if the given object is an instance of AwsKmsConnector. 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 AwsKmsConnector;
/**
* A reference to the Harness secret containing the ARN of the AWS KMS. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
*/
readonly arnRef: pulumi.Output<string>;
/**
* Credentials to connect to AWS.
*/
readonly credentials: pulumi.Output<outputs.platform.AwsKmsConnectorCredentials>;
/**
* Tags to filter delegates for connection.
*/
readonly delegateSelectors: pulumi.Output<string[] | undefined>;
/**
* Description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Unique identifier of the resource.
*/
readonly identifier: pulumi.Output<string>;
/**
* Name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* Unique identifier of the organization.
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* Unique identifier of the project.
*/
readonly projectId: pulumi.Output<string | undefined>;
/**
* The AWS region where the AWS Secret Manager is.
*/
readonly region: pulumi.Output<string>;
/**
* Tags to associate with the resource.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a AwsKmsConnector 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: AwsKmsConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AwsKmsConnector resources.
*/
export interface AwsKmsConnectorState {
/**
* A reference to the Harness secret containing the ARN of the AWS KMS. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
*/
arnRef?: pulumi.Input<string>;
/**
* Credentials to connect to AWS.
*/
credentials?: pulumi.Input<inputs.platform.AwsKmsConnectorCredentials>;
/**
* Tags to filter delegates for connection.
*/
delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier?: pulumi.Input<string>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId?: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId?: pulumi.Input<string>;
/**
* The AWS region where the AWS Secret Manager is.
*/
region?: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a AwsKmsConnector resource.
*/
export interface AwsKmsConnectorArgs {
/**
* A reference to the Harness secret containing the ARN of the AWS KMS. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
*/
arnRef: pulumi.Input<string>;
/**
* Credentials to connect to AWS.
*/
credentials: pulumi.Input<inputs.platform.AwsKmsConnectorCredentials>;
/**
* Tags to filter delegates for connection.
*/
delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier: pulumi.Input<string>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId?: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId?: pulumi.Input<string>;
/**
* The AWS region where the AWS Secret Manager is.
*/
region: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}