1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. TasConnector
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

harness.platform.TasConnector

Explore with Pulumi AI

harness logo
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

    Resource for creating an Tas in Harness.

    Create TasConnector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TasConnector(name: string, args: TasConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def TasConnector(resource_name: str,
                     args: TasConnectorArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def TasConnector(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     credentials: Optional[TasConnectorCredentialsArgs] = None,
                     identifier: Optional[str] = None,
                     delegate_selectors: Optional[Sequence[str]] = None,
                     description: Optional[str] = None,
                     execute_on_delegate: Optional[bool] = None,
                     name: Optional[str] = None,
                     org_id: Optional[str] = None,
                     project_id: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None)
    func NewTasConnector(ctx *Context, name string, args TasConnectorArgs, opts ...ResourceOption) (*TasConnector, error)
    public TasConnector(string name, TasConnectorArgs args, CustomResourceOptions? opts = null)
    public TasConnector(String name, TasConnectorArgs args)
    public TasConnector(String name, TasConnectorArgs args, CustomResourceOptions options)
    
    type: harness:platform:TasConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TasConnectorArgs
    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 TasConnectorArgs
    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 TasConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TasConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TasConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var tasConnectorResource = new Harness.Platform.TasConnector("tasConnectorResource", new()
    {
        Credentials = new Harness.Platform.Inputs.TasConnectorCredentialsArgs
        {
            TasManualDetails = new Harness.Platform.Inputs.TasConnectorCredentialsTasManualDetailsArgs
            {
                EndpointUrl = "string",
                PasswordRef = "string",
                ReferenceToken = "string",
                Username = "string",
                UsernameRef = "string",
            },
            Type = "string",
        },
        Identifier = "string",
        DelegateSelectors = new[]
        {
            "string",
        },
        Description = "string",
        ExecuteOnDelegate = false,
        Name = "string",
        OrgId = "string",
        ProjectId = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := platform.NewTasConnector(ctx, "tasConnectorResource", &platform.TasConnectorArgs{
    	Credentials: &platform.TasConnectorCredentialsArgs{
    		TasManualDetails: &platform.TasConnectorCredentialsTasManualDetailsArgs{
    			EndpointUrl:    pulumi.String("string"),
    			PasswordRef:    pulumi.String("string"),
    			ReferenceToken: pulumi.String("string"),
    			Username:       pulumi.String("string"),
    			UsernameRef:    pulumi.String("string"),
    		},
    		Type: pulumi.String("string"),
    	},
    	Identifier: pulumi.String("string"),
    	DelegateSelectors: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description:       pulumi.String("string"),
    	ExecuteOnDelegate: pulumi.Bool(false),
    	Name:              pulumi.String("string"),
    	OrgId:             pulumi.String("string"),
    	ProjectId:         pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var tasConnectorResource = new TasConnector("tasConnectorResource", TasConnectorArgs.builder()
        .credentials(TasConnectorCredentialsArgs.builder()
            .tasManualDetails(TasConnectorCredentialsTasManualDetailsArgs.builder()
                .endpointUrl("string")
                .passwordRef("string")
                .referenceToken("string")
                .username("string")
                .usernameRef("string")
                .build())
            .type("string")
            .build())
        .identifier("string")
        .delegateSelectors("string")
        .description("string")
        .executeOnDelegate(false)
        .name("string")
        .orgId("string")
        .projectId("string")
        .tags("string")
        .build());
    
    tas_connector_resource = harness.platform.TasConnector("tasConnectorResource",
        credentials=harness.platform.TasConnectorCredentialsArgs(
            tas_manual_details=harness.platform.TasConnectorCredentialsTasManualDetailsArgs(
                endpoint_url="string",
                password_ref="string",
                reference_token="string",
                username="string",
                username_ref="string",
            ),
            type="string",
        ),
        identifier="string",
        delegate_selectors=["string"],
        description="string",
        execute_on_delegate=False,
        name="string",
        org_id="string",
        project_id="string",
        tags=["string"])
    
    const tasConnectorResource = new harness.platform.TasConnector("tasConnectorResource", {
        credentials: {
            tasManualDetails: {
                endpointUrl: "string",
                passwordRef: "string",
                referenceToken: "string",
                username: "string",
                usernameRef: "string",
            },
            type: "string",
        },
        identifier: "string",
        delegateSelectors: ["string"],
        description: "string",
        executeOnDelegate: false,
        name: "string",
        orgId: "string",
        projectId: "string",
        tags: ["string"],
    });
    
    type: harness:platform:TasConnector
    properties:
        credentials:
            tasManualDetails:
                endpointUrl: string
                passwordRef: string
                referenceToken: string
                username: string
                usernameRef: string
            type: string
        delegateSelectors:
            - string
        description: string
        executeOnDelegate: false
        identifier: string
        name: string
        orgId: string
        projectId: string
        tags:
            - string
    

    TasConnector 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 TasConnector resource accepts the following input properties:

    Credentials TasConnectorCredentials
    Contains Tas connector credentials.
    Identifier string
    Unique identifier of the resource.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not.
    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.
    Credentials TasConnectorCredentialsArgs
    Contains Tas connector credentials.
    Identifier string
    Unique identifier of the resource.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not.
    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.
    credentials TasConnectorCredentials
    Contains Tas connector credentials.
    identifier String
    Unique identifier of the resource.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not.
    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.
    credentials TasConnectorCredentials
    Contains Tas connector credentials.
    identifier string
    Unique identifier of the resource.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    executeOnDelegate boolean
    Execute on delegate or not.
    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.
    credentials TasConnectorCredentialsArgs
    Contains Tas connector credentials.
    identifier str
    Unique identifier of the resource.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    execute_on_delegate bool
    Execute on delegate or not.
    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.
    credentials Property Map
    Contains Tas connector credentials.
    identifier String
    Unique identifier of the resource.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not.
    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 TasConnector 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 TasConnector Resource

    Get an existing TasConnector 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?: TasConnectorState, opts?: CustomResourceOptions): TasConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            credentials: Optional[TasConnectorCredentialsArgs] = None,
            delegate_selectors: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            execute_on_delegate: Optional[bool] = None,
            identifier: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None) -> TasConnector
    func GetTasConnector(ctx *Context, name string, id IDInput, state *TasConnectorState, opts ...ResourceOption) (*TasConnector, error)
    public static TasConnector Get(string name, Input<string> id, TasConnectorState? state, CustomResourceOptions? opts = null)
    public static TasConnector get(String name, Output<String> id, TasConnectorState 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:
    Credentials TasConnectorCredentials
    Contains Tas connector credentials.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not.
    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.
    Tags List<string>
    Tags to associate with the resource.
    Credentials TasConnectorCredentialsArgs
    Contains Tas connector credentials.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not.
    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.
    Tags []string
    Tags to associate with the resource.
    credentials TasConnectorCredentials
    Contains Tas connector credentials.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not.
    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.
    tags List<String>
    Tags to associate with the resource.
    credentials TasConnectorCredentials
    Contains Tas connector credentials.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    executeOnDelegate boolean
    Execute on delegate or not.
    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.
    tags string[]
    Tags to associate with the resource.
    credentials TasConnectorCredentialsArgs
    Contains Tas connector credentials.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    execute_on_delegate bool
    Execute on delegate or not.
    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.
    tags Sequence[str]
    Tags to associate with the resource.
    credentials Property Map
    Contains Tas connector credentials.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not.
    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.
    tags List<String>
    Tags to associate with the resource.

    Supporting Types

    TasConnectorCredentials, TasConnectorCredentialsArgs

    TasManualDetails TasConnectorCredentialsTasManualDetails
    Authenticate to Tas using manual details.
    Type string
    Type can be ManualConfig.
    TasManualDetails TasConnectorCredentialsTasManualDetails
    Authenticate to Tas using manual details.
    Type string
    Type can be ManualConfig.
    tasManualDetails TasConnectorCredentialsTasManualDetails
    Authenticate to Tas using manual details.
    type String
    Type can be ManualConfig.
    tasManualDetails TasConnectorCredentialsTasManualDetails
    Authenticate to Tas using manual details.
    type string
    Type can be ManualConfig.
    tas_manual_details TasConnectorCredentialsTasManualDetails
    Authenticate to Tas using manual details.
    type str
    Type can be ManualConfig.
    tasManualDetails Property Map
    Authenticate to Tas using manual details.
    type String
    Type can be ManualConfig.

    TasConnectorCredentialsTasManualDetails, TasConnectorCredentialsTasManualDetailsArgs

    EndpointUrl string
    URL of the Tas server.
    PasswordRef string
    Reference of the secret for the password. 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}.
    ReferenceToken string
    Reference of the secret for the token. 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}
    Username string
    Username to use for authentication.
    UsernameRef string
    Reference to a secret containing the username to use for authentication. 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}.
    EndpointUrl string
    URL of the Tas server.
    PasswordRef string
    Reference of the secret for the password. 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}.
    ReferenceToken string
    Reference of the secret for the token. 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}
    Username string
    Username to use for authentication.
    UsernameRef string
    Reference to a secret containing the username to use for authentication. 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}.
    endpointUrl String
    URL of the Tas server.
    passwordRef String
    Reference of the secret for the password. 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}.
    referenceToken String
    Reference of the secret for the token. 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}
    username String
    Username to use for authentication.
    usernameRef String
    Reference to a secret containing the username to use for authentication. 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}.
    endpointUrl string
    URL of the Tas server.
    passwordRef string
    Reference of the secret for the password. 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}.
    referenceToken string
    Reference of the secret for the token. 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}
    username string
    Username to use for authentication.
    usernameRef string
    Reference to a secret containing the username to use for authentication. 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}.
    endpoint_url str
    URL of the Tas server.
    password_ref str
    Reference of the secret for the password. 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}.
    reference_token str
    Reference of the secret for the token. 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}
    username str
    Username to use for authentication.
    username_ref str
    Reference to a secret containing the username to use for authentication. 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}.
    endpointUrl String
    URL of the Tas server.
    passwordRef String
    Reference of the secret for the password. 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}.
    referenceToken String
    Reference of the secret for the token. 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}
    username String
    Username to use for authentication.
    usernameRef String
    Reference to a secret containing the username to use for authentication. 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}.

    Import

    Import account level tas connector

    $ pulumi import harness:platform/tasConnector:TasConnector example <connector_id>
    

    Import organization level tas connector

    $ pulumi import harness:platform/tasConnector:TasConnector example <organization_id>/<connector_id>
    

    Import project level tas connector

    $ pulumi import harness:platform/tasConnector:TasConnector example <organization_id>/<project_id>/<connector_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.1.2 published on Friday, Jul 19, 2024 by Pulumi