Harness v0.0.5, Oct 31 22

harness.platform.AwsKmsConnector

Resource for creating an AWS KMS connector.

Create AwsKmsConnector Resource

new AwsKmsConnector(name: string, args: AwsKmsConnectorArgs, opts?: CustomResourceOptions);

@overload
def AwsKmsConnector(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    arn_ref: Optional[str] = None,
                    credentials: Optional[AwsKmsConnectorCredentialsArgs] = None,
                    delegate_selectors: Optional[Sequence[str]] = None,
                    description: Optional[str] = None,
                    identifier: Optional[str] = None,
                    name: Optional[str] = None,
                    org_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    region: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None)
@overload
def AwsKmsConnector(resource_name: str,
                    args: AwsKmsConnectorArgs,
                    opts: Optional[ResourceOptions] = None)

func NewAwsKmsConnector(ctx *Context, name string, args AwsKmsConnectorArgs, opts ...ResourceOption) (*AwsKmsConnector, error)

public AwsKmsConnector(string name, AwsKmsConnectorArgs args, CustomResourceOptions? opts = null)

public AwsKmsConnector(String name, AwsKmsConnectorArgs args)
public AwsKmsConnector(String name, AwsKmsConnectorArgs args, CustomResourceOptions options)

type: harness:platform:AwsKmsConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AwsKmsConnectorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AwsKmsConnectorArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AwsKmsConnectorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AwsKmsConnectorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AwsKmsConnectorArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AwsKmsConnector Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AwsKmsConnector resource accepts the following input properties:

ArnRef string: A reference to the Harness secret containing the ARN of the AWS KMS.
Credentials Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
Identifier string: Unique identifier of the resource.
Region string: The AWS region where the AWS Secret Manager is.
DelegateSelectors List<string>: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags List<string>: Tags to associate with the resource. Tags should be in the form name:value.

ArnRef string: A reference to the Harness secret containing the ARN of the AWS KMS.
Credentials AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
Identifier string: Unique identifier of the resource.
Region string: The AWS region where the AWS Secret Manager is.
DelegateSelectors []string: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags []string: Tags to associate with the resource. Tags should be in the form name:value.

arnRef String: A reference to the Harness secret containing the ARN of the AWS KMS.
credentials AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
identifier String: Unique identifier of the resource.
region String: The AWS region where the AWS Secret Manager is.
delegateSelectors List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.

arnRef string: A reference to the Harness secret containing the ARN of the AWS KMS.
credentials AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
identifier string: Unique identifier of the resource.
region string: The AWS region where the AWS Secret Manager is.
delegateSelectors string[]: Connect using only the delegates which have these tags.
description string: Description of the resource.
name string: Name of the resource.
orgId string: Unique identifier of the Organization.
projectId string: Unique identifier of the Project.
tags string[]: Tags to associate with the resource. Tags should be in the form name:value.

arn_ref str: A reference to the Harness secret containing the ARN of the AWS KMS.
credentials AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
identifier str: Unique identifier of the resource.
region str: The AWS region where the AWS Secret Manager is.
delegate_selectors Sequence[str]: Connect using only the delegates which have these tags.
description str: Description of the resource.
name str: Name of the resource.
org_id str: Unique identifier of the Organization.
project_id str: Unique identifier of the Project.
tags Sequence[str]: Tags to associate with the resource. Tags should be in the form name:value.

arnRef String: A reference to the Harness secret containing the ARN of the AWS KMS.
credentials Property Map: The credentials to use for connecting to aws.
identifier String: Unique identifier of the resource.
region String: The AWS region where the AWS Secret Manager is.
delegateSelectors List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.

Outputs

All input properties are implicitly available as output properties. Additionally, the AwsKmsConnector resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing AwsKmsConnector Resource

Get an existing AwsKmsConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AwsKmsConnectorState, opts?: CustomResourceOptions): AwsKmsConnector

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn_ref: Optional[str] = None,
        credentials: Optional[AwsKmsConnectorCredentialsArgs] = None,
        delegate_selectors: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        identifier: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> AwsKmsConnector

func GetAwsKmsConnector(ctx *Context, name string, id IDInput, state *AwsKmsConnectorState, opts ...ResourceOption) (*AwsKmsConnector, error)

public static AwsKmsConnector Get(string name, Input<string> id, AwsKmsConnectorState? state, CustomResourceOptions? opts = null)

public static AwsKmsConnector get(String name, Output<String> id, AwsKmsConnectorState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ArnRef string: A reference to the Harness secret containing the ARN of the AWS KMS.
Credentials Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
DelegateSelectors List<string>: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Region string: The AWS region where the AWS Secret Manager is.
Tags List<string>: Tags to associate with the resource. Tags should be in the form name:value.

ArnRef string: A reference to the Harness secret containing the ARN of the AWS KMS.
Credentials AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
DelegateSelectors []string: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Region string: The AWS region where the AWS Secret Manager is.
Tags []string: Tags to associate with the resource. Tags should be in the form name:value.

arnRef String: A reference to the Harness secret containing the ARN of the AWS KMS.
credentials AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
delegateSelectors List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
identifier String: Unique identifier of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
region String: The AWS region where the AWS Secret Manager is.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.

arnRef string: A reference to the Harness secret containing the ARN of the AWS KMS.
credentials AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
delegateSelectors string[]: Connect using only the delegates which have these tags.
description string: Description of the resource.
identifier string: Unique identifier of the resource.
name string: Name of the resource.
orgId string: Unique identifier of the Organization.
projectId string: Unique identifier of the Project.
region string: The AWS region where the AWS Secret Manager is.
tags string[]: Tags to associate with the resource. Tags should be in the form name:value.

arn_ref str: A reference to the Harness secret containing the ARN of the AWS KMS.
credentials AwsKmsConnectorCredentialsArgs: The credentials to use for connecting to aws.
delegate_selectors Sequence[str]: Connect using only the delegates which have these tags.
description str: Description of the resource.
identifier str: Unique identifier of the resource.
name str: Name of the resource.
org_id str: Unique identifier of the Organization.
project_id str: Unique identifier of the Project.
region str: The AWS region where the AWS Secret Manager is.
tags Sequence[str]: Tags to associate with the resource. Tags should be in the form name:value.

arnRef String: A reference to the Harness secret containing the ARN of the AWS KMS.
credentials Property Map: The credentials to use for connecting to aws.
delegateSelectors List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
identifier String: Unique identifier of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
region String: The AWS region where the AWS Secret Manager is.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.

Supporting Types

AwsKmsConnectorCredentials

AssumeRole Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsKmsConnectorCredentialsAssumeRole: Connect using STS assume role.
InheritFromDelegate bool: Inherit the credentials from from the delegate.
Manual Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsKmsConnectorCredentialsManual: Specify the AWS key and secret used for authenticating.

AssumeRole AwsKmsConnectorCredentialsAssumeRole: Connect using STS assume role.
InheritFromDelegate bool: Inherit the credentials from from the delegate.
Manual AwsKmsConnectorCredentialsManual: Specify the AWS key and secret used for authenticating.

assumeRole AwsKmsConnectorCredentialsAssumeRole: Connect using STS assume role.
inheritFromDelegate Boolean: Inherit the credentials from from the delegate.
manual AwsKmsConnectorCredentialsManual: Specify the AWS key and secret used for authenticating.

assumeRole AwsKmsConnectorCredentialsAssumeRole: Connect using STS assume role.
inheritFromDelegate boolean: Inherit the credentials from from the delegate.
manual AwsKmsConnectorCredentialsManual: Specify the AWS key and secret used for authenticating.

assume_role AwsKmsConnectorCredentialsAssumeRole: Connect using STS assume role.
inherit_from_delegate bool: Inherit the credentials from from the delegate.
manual AwsKmsConnectorCredentialsManual: Specify the AWS key and secret used for authenticating.

assumeRole Property Map: Connect using STS assume role.
inheritFromDelegate Boolean: Inherit the credentials from from the delegate.
manual Property Map: Specify the AWS key and secret used for authenticating.