Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. DockerConnector
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

harness.platform.DockerConnector

Explore with Pulumi AI

harness logo
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

    Resource for creating a Docker connector.

    Example to create Docker Connector at different levels (Org, Project, Account)

    Create DockerConnector Resource

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

    Constructor syntax

    new DockerConnector(name: string, args: DockerConnectorArgs, opts?: CustomResourceOptions);
    @overload
def DockerConnector(resource_name: str,
                    args: DockerConnectorArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def DockerConnector(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    identifier: Optional[str] = None,
                    type: Optional[str] = None,
                    url: Optional[str] = None,
                    credentials: Optional[DockerConnectorCredentialsArgs] = 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 NewDockerConnector(ctx *Context, name string, args DockerConnectorArgs, opts ...ResourceOption) (*DockerConnector, error)
    public DockerConnector(string name, DockerConnectorArgs args, CustomResourceOptions? opts = null)
    public DockerConnector(String name, DockerConnectorArgs args)
public DockerConnector(String name, DockerConnectorArgs args, CustomResourceOptions options)

    type: harness:platform:DockerConnector
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 DockerConnectorArgs
    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 DockerConnectorArgs
    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 DockerConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DockerConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DockerConnectorArgs
    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 dockerConnectorResource = new Harness.Platform.DockerConnector("dockerConnectorResource", new()
{
    Identifier = "string",
    Type = "string",
    Url = "string",
    Credentials = new Harness.Platform.Inputs.DockerConnectorCredentialsArgs
    {
        PasswordRef = "string",
        Username = "string",
        UsernameRef = "string",
    },
    DelegateSelectors = new[]
    {
        "string",
    },
    Description = "string",
    ExecuteOnDelegate = false,
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := platform.NewDockerConnector(ctx, "dockerConnectorResource", &platform.DockerConnectorArgs{
	Identifier: pulumi.String("string"),
	Type:       pulumi.String("string"),
	Url:        pulumi.String("string"),
	Credentials: &platform.DockerConnectorCredentialsArgs{
		PasswordRef: pulumi.String("string"),
		Username:    pulumi.String("string"),
		UsernameRef: 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 dockerConnectorResource = new DockerConnector("dockerConnectorResource", DockerConnectorArgs.builder()
    .identifier("string")
    .type("string")
    .url("string")
    .credentials(DockerConnectorCredentialsArgs.builder()
        .passwordRef("string")
        .username("string")
        .usernameRef("string")
        .build())
    .delegateSelectors("string")
    .description("string")
    .executeOnDelegate(false)
    .name("string")
    .orgId("string")
    .projectId("string")
    .tags("string")
    .build());

    docker_connector_resource = harness.platform.DockerConnector("dockerConnectorResource",
    identifier="string",
    type="string",
    url="string",
    credentials={
        "password_ref": "string",
        "username": "string",
        "username_ref": "string",
    },
    delegate_selectors=["string"],
    description="string",
    execute_on_delegate=False,
    name="string",
    org_id="string",
    project_id="string",
    tags=["string"])

    const dockerConnectorResource = new harness.platform.DockerConnector("dockerConnectorResource", {
    identifier: "string",
    type: "string",
    url: "string",
    credentials: {
        passwordRef: "string",
        username: "string",
        usernameRef: "string",
    },
    delegateSelectors: ["string"],
    description: "string",
    executeOnDelegate: false,
    name: "string",
    orgId: "string",
    projectId: "string",
    tags: ["string"],
});

    type: harness:platform:DockerConnector
properties:
    credentials:
        passwordRef: string
        username: string
        usernameRef: string
    delegateSelectors:
        - string
    description: string
    executeOnDelegate: false
    identifier: string
    name: string
    orgId: string
    projectId: string
    tags:
        - string
    type: string
    url: string

    DockerConnector Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DockerConnector resource accepts the following input properties:

    Identifier string
    Unique identifier of the resource.
    Type string
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    Url string
    The URL of the docker registry.
    Credentials DockerConnectorCredentials
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    Identifier string
    Unique identifier of the resource.
    Type string
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    Url string
    The URL of the docker registry.
    Credentials DockerConnectorCredentialsArgs
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    identifier String
    Unique identifier of the resource.
    type String
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    url String
    The URL of the docker registry.
    credentials DockerConnectorCredentials
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    identifier string
    Unique identifier of the resource.
    type string
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    url string
    The URL of the docker registry.
    credentials DockerConnectorCredentials
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    identifier str
    Unique identifier of the resource.
    type str
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    url str
    The URL of the docker registry.
    credentials DockerConnectorCredentialsArgs
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    identifier String
    Unique identifier of the resource.
    type String
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    url String
    The URL of the docker registry.
    credentials Property Map
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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 DockerConnector 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 DockerConnector Resource

    Get an existing DockerConnector 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?: DockerConnectorState, opts?: CustomResourceOptions): DockerConnector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credentials: Optional[DockerConnectorCredentialsArgs] = 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,
        type: Optional[str] = None,
        url: Optional[str] = None) -> DockerConnector
    func GetDockerConnector(ctx *Context, name string, id IDInput, state *DockerConnectorState, opts ...ResourceOption) (*DockerConnector, error)
    public static DockerConnector Get(string name, Input<string> id, DockerConnectorState? state, CustomResourceOptions? opts = null)
    public static DockerConnector get(String name, Output<String> id, DockerConnectorState 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 DockerConnectorCredentials
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    Type string
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    Url string
    The URL of the docker registry.
    Credentials DockerConnectorCredentialsArgs
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    Type string
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    Url string
    The URL of the docker registry.
    credentials DockerConnectorCredentials
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    type String
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    url String
    The URL of the docker registry.
    credentials DockerConnectorCredentials
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    type string
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    url string
    The URL of the docker registry.
    credentials DockerConnectorCredentialsArgs
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    type str
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    url str
    The URL of the docker registry.
    credentials Property Map
    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
    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.
    type String
    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
    url String
    The URL of the docker registry.

    Supporting Types

    DockerConnectorCredentials, DockerConnectorCredentialsArgs

    PasswordRef string
    The reference to the Harness secret containing the password to use for the docker registry. 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}. To reference a secret at the project scope, use directly without any prefix.
    Username string
    The username to use for the docker registry.
    UsernameRef string
    The reference to the Harness secret containing the username to use for the docker registry. 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}.
    PasswordRef string
    The reference to the Harness secret containing the password to use for the docker registry. 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}. To reference a secret at the project scope, use directly without any prefix.
    Username string
    The username to use for the docker registry.
    UsernameRef string
    The reference to the Harness secret containing the username to use for the docker registry. 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}.
    passwordRef String
    The reference to the Harness secret containing the password to use for the docker registry. 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}. To reference a secret at the project scope, use directly without any prefix.
    username String
    The username to use for the docker registry.
    usernameRef String
    The reference to the Harness secret containing the username to use for the docker registry. 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}.
    passwordRef string
    The reference to the Harness secret containing the password to use for the docker registry. 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}. To reference a secret at the project scope, use directly without any prefix.
    username string
    The username to use for the docker registry.
    usernameRef string
    The reference to the Harness secret containing the username to use for the docker registry. 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}.
    password_ref str
    The reference to the Harness secret containing the password to use for the docker registry. 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}. To reference a secret at the project scope, use directly without any prefix.
    username str
    The username to use for the docker registry.
    username_ref str
    The reference to the Harness secret containing the username to use for the docker registry. 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}.
    passwordRef String
    The reference to the Harness secret containing the password to use for the docker registry. 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}. To reference a secret at the project scope, use directly without any prefix.
    username String
    The username to use for the docker registry.
    usernameRef String
    The reference to the Harness secret containing the username to use for the docker registry. 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 docker connector

    $ pulumi import harness:platform/dockerConnector:DockerConnector example <connector_id>

    Import org level docker connector

    $ pulumi import harness:platform/dockerConnector:DockerConnector example <ord_id>/<connector_id>

    Import project level docker connector

    $ pulumi import harness:platform/dockerConnector:DockerConnector example <org_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.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-harness