1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. AwsKmsConnector
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.AwsKmsConnector

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

    Resource for creating an AWS KMS connector.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Lbrlabs.PulumiPackage.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        // Credentials inherit_from_delegate
        var test = new Harness.Platform.AwsKmsConnector("test", new()
        {
            ArnRef = "account.secret_id",
            Credentials = new Harness.Platform.Inputs.AwsKmsConnectorCredentialsArgs
            {
                InheritFromDelegate = true,
            },
            DelegateSelectors = new[]
            {
                "harness-delegate",
            },
            Description = "test",
            Identifier = "identifer",
            Region = "us-east-1",
            Tags = new[]
            {
                "foo:bar",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewAwsKmsConnector(ctx, "test", &platform.AwsKmsConnectorArgs{
    			ArnRef: pulumi.String("account.secret_id"),
    			Credentials: &platform.AwsKmsConnectorCredentialsArgs{
    				InheritFromDelegate: pulumi.Bool(true),
    			},
    			DelegateSelectors: pulumi.StringArray{
    				pulumi.String("harness-delegate"),
    			},
    			Description: pulumi.String("test"),
    			Identifier:  pulumi.String("identifer"),
    			Region:      pulumi.String("us-east-1"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.AwsKmsConnector;
    import com.pulumi.harness.platform.AwsKmsConnectorArgs;
    import com.pulumi.harness.platform.inputs.AwsKmsConnectorCredentialsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new AwsKmsConnector("test", AwsKmsConnectorArgs.builder()        
                .arnRef("account.secret_id")
                .credentials(AwsKmsConnectorCredentialsArgs.builder()
                    .inheritFromDelegate(true)
                    .build())
                .delegateSelectors("harness-delegate")
                .description("test")
                .identifier("identifer")
                .region("us-east-1")
                .tags("foo:bar")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_harness as harness
    
    # Credentials inherit_from_delegate
    test = harness.platform.AwsKmsConnector("test",
        arn_ref="account.secret_id",
        credentials=harness.platform.AwsKmsConnectorCredentialsArgs(
            inherit_from_delegate=True,
        ),
        delegate_selectors=["harness-delegate"],
        description="test",
        identifier="identifer",
        region="us-east-1",
        tags=["foo:bar"])
    
    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"],
    });
    
    resources:
      # Credentials inherit_from_delegate
      test:
        type: harness:platform:AwsKmsConnector
        properties:
          arnRef: account.secret_id
          credentials:
            inheritFromDelegate: true
          delegateSelectors:
            - harness-delegate
          description: test
          identifier: identifer
          region: us-east-1
          tags:
            - foo:bar
    

    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. 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}.
    Credentials Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsKmsConnectorCredentials
    Credentials to connect to AWS.
    Identifier string
    Unique identifier of the resource.
    Region string
    The AWS region where the AWS Secret Manager is.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    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.
    ArnRef string
    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}.
    Credentials AwsKmsConnectorCredentialsArgs
    Credentials to connect to AWS.
    Identifier string
    Unique identifier of the resource.
    Region string
    The AWS region where the AWS Secret Manager is.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    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.
    arnRef String
    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}.
    credentials AwsKmsConnectorCredentials
    Credentials to connect to AWS.
    identifier String
    Unique identifier of the resource.
    region String
    The AWS region where the AWS Secret Manager is.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    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.
    arnRef string
    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}.
    credentials AwsKmsConnectorCredentials
    Credentials to connect to AWS.
    identifier string
    Unique identifier of the resource.
    region string
    The AWS region where the AWS Secret Manager is.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    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.
    arn_ref str
    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}.
    credentials AwsKmsConnectorCredentialsArgs
    Credentials to connect to AWS.
    identifier str
    Unique identifier of the resource.
    region str
    The AWS region where the AWS Secret Manager is.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    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.
    arnRef String
    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}.
    credentials Property Map
    Credentials to connect to AWS.
    identifier String
    Unique identifier of the resource.
    region String
    The AWS region where the AWS Secret Manager is.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    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.

    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. 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}.
    Credentials Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsKmsConnectorCredentials
    Credentials to connect to AWS.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    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.
    ArnRef string
    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}.
    Credentials AwsKmsConnectorCredentialsArgs
    Credentials to connect to AWS.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    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.
    arnRef String
    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}.
    credentials AwsKmsConnectorCredentials
    Credentials to connect to AWS.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    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.
    arnRef string
    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}.
    credentials AwsKmsConnectorCredentials
    Credentials to connect to AWS.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    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.
    arn_ref str
    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}.
    credentials AwsKmsConnectorCredentialsArgs
    Credentials to connect to AWS.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    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.
    arnRef String
    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}.
    credentials Property Map
    Credentials to connect to AWS.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    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.

    Supporting Types

    AwsKmsConnectorCredentials, AwsKmsConnectorCredentialsArgs

    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.

    AwsKmsConnectorCredentialsAssumeRole, AwsKmsConnectorCredentialsAssumeRoleArgs

    Duration int
    RoleArn string
    ExternalId string
    Duration int
    RoleArn string
    ExternalId string
    duration Integer
    roleArn String
    externalId String
    duration number
    roleArn string
    externalId string
    duration Number
    roleArn String
    externalId String

    AwsKmsConnectorCredentialsManual, AwsKmsConnectorCredentialsManualArgs

    Import

    Import account level awskms connector

     $ pulumi import harness:platform/awsKmsConnector:AwsKmsConnector example <connector_id>
    

    Import org level awskms connector

     $ pulumi import harness:platform/awsKmsConnector:AwsKmsConnector example <ord_id>/<connector_id>
    

    Import project level awskms connector

     $ pulumi import harness:platform/awsKmsConnector:AwsKmsConnector example <org_id>/<project_id>/<connector_id>
    

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs