Harness v0.0.5, Oct 31 22

harness.platform.DockerConnector

Resource for creating a Docker connector.

Create DockerConnector Resource

new DockerConnector(name: string, args: DockerConnectorArgs, opts?: CustomResourceOptions);

@overload
def DockerConnector(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    credentials: Optional[DockerConnectorCredentialsArgs] = 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,
                    tags: Optional[Sequence[str]] = None,
                    type: Optional[str] = None,
                    url: Optional[str] = None)
@overload
def DockerConnector(resource_name: str,
                    args: DockerConnectorArgs,
                    opts: Optional[ResourceOptions] = 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.

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.

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

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 Lbrlabs.PulumiPackage.Harness.Platform.Inputs.DockerConnectorCredentialsArgs: The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
DelegateSelectors List<string>: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags List<string>: Tags to associate with the resource. Tags should be in the form name:value.

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: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags []string: Tags to associate with the resource. Tags should be in the form name:value.

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 List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.

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[]: Connect using only the delegates which have these tags.
description string: Description of the resource.
name string: Name of the resource.
orgId string: Unique identifier of the Organization.
projectId string: Unique identifier of the Project.
tags string[]: Tags to associate with the resource. Tags should be in the form name:value.

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]: Connect using only the delegates which have these tags.
description str: Description of the resource.
name str: Name of the resource.
org_id str: Unique identifier of the Organization.
project_id str: Unique identifier of the Project.
tags Sequence[str]: Tags to associate with the resource. Tags should be in the form name:value.

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>: Connect using only the delegates which have these tags.
description String: Description of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.

Outputs

All input properties are implicitly available as output properties. Additionally, the 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,
        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 Lbrlabs.PulumiPackage.Harness.Platform.Inputs.DockerConnectorCredentialsArgs: The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
DelegateSelectors List<string>: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags List<string>: Tags to associate with the resource. Tags should be in the form name:value.
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: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags []string: Tags to associate with the resource. Tags should be in the form name:value.
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 List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
identifier String: Unique identifier of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.
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[]: Connect using only the delegates which have these tags.
description string: Description of the resource.
identifier string: Unique identifier of the resource.
name string: Name of the resource.
orgId string: Unique identifier of the Organization.
projectId string: Unique identifier of the Project.
tags string[]: Tags to associate with the resource. Tags should be in the form name:value.
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]: Connect using only the delegates which have these tags.
description str: Description of the resource.
identifier str: Unique identifier of the resource.
name str: Name of the resource.
org_id str: Unique identifier of the Organization.
project_id str: Unique identifier of the Project.
tags Sequence[str]: Tags to associate with the resource. Tags should be in the form name:value.
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>: Connect using only the delegates which have these tags.
description String: Description of the resource.
identifier String: Unique identifier of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.
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

PasswordRef string: The reference to the password to use for the docker registry.
Username string: The username to use for the docker registry.
UsernameRef string: The reference to the username to use for the docker registry.

PasswordRef string: The reference to the password to use for the docker registry.
Username string: The username to use for the docker registry.
UsernameRef string: The reference to the username to use for the docker registry.

passwordRef String: The reference to the password to use for the docker registry.
username String: The username to use for the docker registry.
usernameRef String: The reference to the username to use for the docker registry.

passwordRef string: The reference to the password to use for the docker registry.
username string: The username to use for the docker registry.
usernameRef string: The reference to the username to use for the docker registry.

password_ref str: The reference to the password to use for the docker registry.
username str: The username to use for the docker registry.
username_ref str: The reference to the username to use for the docker registry.

passwordRef String: The reference to the password to use for the docker registry.
username String: The username to use for the docker registry.
usernameRef String: The reference to the username to use for the docker registry.

Package Details

Repository: harness lbrlabs/pulumi-harness
License: Apache-2.0
Notes: This Pulumi package is based on the harness Terraform Provider.