1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. getAwsKmsConnector
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi

harness.platform.getAwsKmsConnector

Explore with Pulumi AI

harness logo
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = harness.platform.getAwsKmsConnector({
        identifier: "identifier",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.platform.get_aws_kms_connector(identifier="identifier")
    
    package main
    
    import (
    	"github.com/pulumi/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.LookupAwsKmsConnector(ctx, &platform.LookupAwsKmsConnectorArgs{
    			Identifier: "identifier",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Harness.Platform.GetAwsKmsConnector.Invoke(new()
        {
            Identifier = "identifier",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.PlatformFunctions;
    import com.pulumi.harness.platform.inputs.GetAwsKmsConnectorArgs;
    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) {
            final var example = PlatformFunctions.getAwsKmsConnector(GetAwsKmsConnectorArgs.builder()
                .identifier("identifier")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: harness:platform:getAwsKmsConnector
          Arguments:
            identifier: identifier
    

    Using getAwsKmsConnector

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAwsKmsConnector(args: GetAwsKmsConnectorArgs, opts?: InvokeOptions): Promise<GetAwsKmsConnectorResult>
    function getAwsKmsConnectorOutput(args: GetAwsKmsConnectorOutputArgs, opts?: InvokeOptions): Output<GetAwsKmsConnectorResult>
    def get_aws_kms_connector(identifier: Optional[str] = None,
                              name: Optional[str] = None,
                              org_id: Optional[str] = None,
                              project_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAwsKmsConnectorResult
    def get_aws_kms_connector_output(identifier: Optional[pulumi.Input[str]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              org_id: Optional[pulumi.Input[str]] = None,
                              project_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAwsKmsConnectorResult]
    func LookupAwsKmsConnector(ctx *Context, args *LookupAwsKmsConnectorArgs, opts ...InvokeOption) (*LookupAwsKmsConnectorResult, error)
    func LookupAwsKmsConnectorOutput(ctx *Context, args *LookupAwsKmsConnectorOutputArgs, opts ...InvokeOption) LookupAwsKmsConnectorResultOutput

    > Note: This function is named LookupAwsKmsConnector in the Go SDK.

    public static class GetAwsKmsConnector 
    {
        public static Task<GetAwsKmsConnectorResult> InvokeAsync(GetAwsKmsConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetAwsKmsConnectorResult> Invoke(GetAwsKmsConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAwsKmsConnectorResult> getAwsKmsConnector(GetAwsKmsConnectorArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: harness:platform/getAwsKmsConnector:getAwsKmsConnector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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.
    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.
    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.

    getAwsKmsConnector Result

    The following output properties are available:

    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 List<GetAwsKmsConnectorCredential>
    Credentials to connect to AWS.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Region string
    The AWS region where the AWS Secret Manager is.
    Tags List<string>
    Tags to associate with the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    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 []GetAwsKmsConnectorCredential
    Credentials to connect to AWS.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Region string
    The AWS region where the AWS Secret Manager is.
    Tags []string
    Tags to associate with the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    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 List<GetAwsKmsConnectorCredential>
    Credentials to connect to AWS.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    region String
    The AWS region where the AWS Secret Manager is.
    tags List<String>
    Tags to associate with the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    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 GetAwsKmsConnectorCredential[]
    Credentials to connect to AWS.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Unique identifier of the resource.
    region string
    The AWS region where the AWS Secret Manager is.
    tags string[]
    Tags to associate with the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    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 Sequence[GetAwsKmsConnectorCredential]
    Credentials to connect to AWS.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Unique identifier of the resource.
    region str
    The AWS region where the AWS Secret Manager is.
    tags Sequence[str]
    Tags to associate with the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    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 List<Property Map>
    Credentials to connect to AWS.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    region String
    The AWS region where the AWS Secret Manager is.
    tags List<String>
    Tags to associate with the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    Supporting Types

    GetAwsKmsConnectorCredential

    AssumeRoles List<GetAwsKmsConnectorCredentialAssumeRole>
    Connect using STS assume role.
    InheritFromDelegate bool
    Inherit the credentials from from the delegate.
    Manuals List<GetAwsKmsConnectorCredentialManual>
    Specify the AWS key and secret used for authenticating.
    AssumeRoles []GetAwsKmsConnectorCredentialAssumeRole
    Connect using STS assume role.
    InheritFromDelegate bool
    Inherit the credentials from from the delegate.
    Manuals []GetAwsKmsConnectorCredentialManual
    Specify the AWS key and secret used for authenticating.
    assumeRoles List<GetAwsKmsConnectorCredentialAssumeRole>
    Connect using STS assume role.
    inheritFromDelegate Boolean
    Inherit the credentials from from the delegate.
    manuals List<GetAwsKmsConnectorCredentialManual>
    Specify the AWS key and secret used for authenticating.
    assumeRoles GetAwsKmsConnectorCredentialAssumeRole[]
    Connect using STS assume role.
    inheritFromDelegate boolean
    Inherit the credentials from from the delegate.
    manuals GetAwsKmsConnectorCredentialManual[]
    Specify the AWS key and secret used for authenticating.
    assume_roles Sequence[GetAwsKmsConnectorCredentialAssumeRole]
    Connect using STS assume role.
    inherit_from_delegate bool
    Inherit the credentials from from the delegate.
    manuals Sequence[GetAwsKmsConnectorCredentialManual]
    Specify the AWS key and secret used for authenticating.
    assumeRoles List<Property Map>
    Connect using STS assume role.
    inheritFromDelegate Boolean
    Inherit the credentials from from the delegate.
    manuals List<Property Map>
    Specify the AWS key and secret used for authenticating.

    GetAwsKmsConnectorCredentialAssumeRole

    Duration int
    The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the client request body. The minimum value is 1 hour.
    ExternalId string
    If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
    RoleArn string
    The ARN of the role to assume.
    Duration int
    The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the client request body. The minimum value is 1 hour.
    ExternalId string
    If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
    RoleArn string
    The ARN of the role to assume.
    duration Integer
    The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the client request body. The minimum value is 1 hour.
    externalId String
    If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
    roleArn String
    The ARN of the role to assume.
    duration number
    The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the client request body. The minimum value is 1 hour.
    externalId string
    If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
    roleArn string
    The ARN of the role to assume.
    duration int
    The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the client request body. The minimum value is 1 hour.
    external_id str
    If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
    role_arn str
    The ARN of the role to assume.
    duration Number
    The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the client request body. The minimum value is 1 hour.
    externalId String
    If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
    roleArn String
    The ARN of the role to assume.

    GetAwsKmsConnectorCredentialManual

    AccessKeyRef string
    The reference to the Harness secret containing the AWS access key. 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}.
    SecretKeyRef string
    The reference to the Harness secret containing the AWS secret key. 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}.
    AccessKeyRef string
    The reference to the Harness secret containing the AWS access key. 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}.
    SecretKeyRef string
    The reference to the Harness secret containing the AWS secret key. 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}.
    accessKeyRef String
    The reference to the Harness secret containing the AWS access key. 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}.
    secretKeyRef String
    The reference to the Harness secret containing the AWS secret key. 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}.
    accessKeyRef string
    The reference to the Harness secret containing the AWS access key. 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}.
    secretKeyRef string
    The reference to the Harness secret containing the AWS secret key. 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}.
    access_key_ref str
    The reference to the Harness secret containing the AWS access key. 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}.
    secret_key_ref str
    The reference to the Harness secret containing the AWS secret key. 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}.
    accessKeyRef String
    The reference to the Harness secret containing the AWS access key. 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}.
    secretKeyRef String
    The reference to the Harness secret containing the AWS secret key. 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}.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi