Harbor v3.10.15, Sep 28 24

Harbor v3.10.15 published on Saturday, Sep 28, 2024 by Pulumiverse

harbor.PreheatInstance

Explore with Pulumi AI

Harbor v3.10.15 published on Saturday, Sep 28, 2024 by Pulumiverse

pulumiverse/pulumi-harbor

Example Usage

Basic Usage

resource "harbor_preheat_instance" "example" {
  name     = "example-preheat-instance"
  vendor   = "dragonfly"
  endpoint = "http://example.com"
}

Usage with Authentication

resource "harbor_preheat_instance" "example" {
  name       = "example-preheat-instance"
  vendor     = "dragonfly"
  endpoint   = "http://example.com"
  auth_mode  = "BASIC"
  username   = "example-user"
  password   = "example-password"
}

Create PreheatInstance Resource

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

Constructor syntax

new PreheatInstance(name: string, args: PreheatInstanceArgs, opts?: CustomResourceOptions);

@overload
def PreheatInstance(resource_name: str,
                    args: PreheatInstanceArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def PreheatInstance(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    endpoint: Optional[str] = None,
                    vendor: Optional[str] = None,
                    auth_mode: Optional[str] = None,
                    default: Optional[bool] = None,
                    description: Optional[str] = None,
                    enabled: Optional[bool] = None,
                    insecure: Optional[bool] = None,
                    name: Optional[str] = None,
                    password: Optional[str] = None,
                    token: Optional[str] = None,
                    username: Optional[str] = None)

func NewPreheatInstance(ctx *Context, name string, args PreheatInstanceArgs, opts ...ResourceOption) (*PreheatInstance, error)

public PreheatInstance(string name, PreheatInstanceArgs args, CustomResourceOptions? opts = null)

public PreheatInstance(String name, PreheatInstanceArgs args)
public PreheatInstance(String name, PreheatInstanceArgs args, CustomResourceOptions options)

type: harbor:PreheatInstance
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 PreheatInstanceArgs: 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 PreheatInstanceArgs: 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 PreheatInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PreheatInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PreheatInstanceArgs: 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 preheatInstanceResource = new Harbor.PreheatInstance("preheatInstanceResource", new()
{
    Endpoint = "string",
    Vendor = "string",
    AuthMode = "string",
    Default = false,
    Description = "string",
    Enabled = false,
    Insecure = false,
    Name = "string",
    Password = "string",
    Token = "string",
    Username = "string",
});

example, err := harbor.NewPreheatInstance(ctx, "preheatInstanceResource", &harbor.PreheatInstanceArgs{
	Endpoint:    pulumi.String("string"),
	Vendor:      pulumi.String("string"),
	AuthMode:    pulumi.String("string"),
	Default:     pulumi.Bool(false),
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Insecure:    pulumi.Bool(false),
	Name:        pulumi.String("string"),
	Password:    pulumi.String("string"),
	Token:       pulumi.String("string"),
	Username:    pulumi.String("string"),
})

var preheatInstanceResource = new PreheatInstance("preheatInstanceResource", PreheatInstanceArgs.builder()
    .endpoint("string")
    .vendor("string")
    .authMode("string")
    .default_(false)
    .description("string")
    .enabled(false)
    .insecure(false)
    .name("string")
    .password("string")
    .token("string")
    .username("string")
    .build());

preheat_instance_resource = harbor.PreheatInstance("preheatInstanceResource",
    endpoint="string",
    vendor="string",
    auth_mode="string",
    default=False,
    description="string",
    enabled=False,
    insecure=False,
    name="string",
    password="string",
    token="string",
    username="string")

const preheatInstanceResource = new harbor.PreheatInstance("preheatInstanceResource", {
    endpoint: "string",
    vendor: "string",
    authMode: "string",
    "default": false,
    description: "string",
    enabled: false,
    insecure: false,
    name: "string",
    password: "string",
    token: "string",
    username: "string",
});

type: harbor:PreheatInstance
properties:
    authMode: string
    default: false
    description: string
    enabled: false
    endpoint: string
    insecure: false
    name: string
    password: string
    token: string
    username: string
    vendor: string

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

Endpoint string: The endpoint of the preheat instance.
Vendor string: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".
AuthMode string: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
Default bool: Whether the preheat instance is the default instance. Defaults to false.
Description string: The description of the preheat instance. Defaults to an empty string.
Enabled bool: Whether the preheat instance is enabled. Defaults to true.
Insecure bool: Whether to allow insecure connections to the preheat instance. Defaults to false.
Name string: The name of the preheat instance.
Password string: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
Token string: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
Username string: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.

Endpoint string: The endpoint of the preheat instance.
Vendor string: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".
AuthMode string: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
Default bool: Whether the preheat instance is the default instance. Defaults to false.
Description string: The description of the preheat instance. Defaults to an empty string.
Enabled bool: Whether the preheat instance is enabled. Defaults to true.
Insecure bool: Whether to allow insecure connections to the preheat instance. Defaults to false.
Name string: The name of the preheat instance.
Password string: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
Token string: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
Username string: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.

endpoint String: The endpoint of the preheat instance.
vendor String: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".
authMode String: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
default_ Boolean: Whether the preheat instance is the default instance. Defaults to false.
description String: The description of the preheat instance. Defaults to an empty string.
enabled Boolean: Whether the preheat instance is enabled. Defaults to true.
insecure Boolean: Whether to allow insecure connections to the preheat instance. Defaults to false.
name String: The name of the preheat instance.
password String: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
token String: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
username String: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.

endpoint string: The endpoint of the preheat instance.
vendor string: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".
authMode string: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
default boolean: Whether the preheat instance is the default instance. Defaults to false.
description string: The description of the preheat instance. Defaults to an empty string.
enabled boolean: Whether the preheat instance is enabled. Defaults to true.
insecure boolean: Whether to allow insecure connections to the preheat instance. Defaults to false.
name string: The name of the preheat instance.
password string: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
token string: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
username string: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.

endpoint str: The endpoint of the preheat instance.
vendor str: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".
auth_mode str: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
default bool: Whether the preheat instance is the default instance. Defaults to false.
description str: The description of the preheat instance. Defaults to an empty string.
enabled bool: Whether the preheat instance is enabled. Defaults to true.
insecure bool: Whether to allow insecure connections to the preheat instance. Defaults to false.
name str: The name of the preheat instance.
password str: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
token str: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
username str: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.

endpoint String: The endpoint of the preheat instance.
vendor String: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".
authMode String: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
default Boolean: Whether the preheat instance is the default instance. Defaults to false.
description String: The description of the preheat instance. Defaults to an empty string.
enabled Boolean: Whether the preheat instance is enabled. Defaults to true.
insecure Boolean: Whether to allow insecure connections to the preheat instance. Defaults to false.
name String: The name of the preheat instance.
password String: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
token String: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
username String: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.

Outputs

All input properties are implicitly available as output properties. Additionally, the PreheatInstance 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 PreheatInstance Resource

Get an existing PreheatInstance 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?: PreheatInstanceState, opts?: CustomResourceOptions): PreheatInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_mode: Optional[str] = None,
        default: Optional[bool] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        endpoint: Optional[str] = None,
        insecure: Optional[bool] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        token: Optional[str] = None,
        username: Optional[str] = None,
        vendor: Optional[str] = None) -> PreheatInstance

func GetPreheatInstance(ctx *Context, name string, id IDInput, state *PreheatInstanceState, opts ...ResourceOption) (*PreheatInstance, error)

public static PreheatInstance Get(string name, Input<string> id, PreheatInstanceState? state, CustomResourceOptions? opts = null)

public static PreheatInstance get(String name, Output<String> id, PreheatInstanceState 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:

AuthMode string: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
Default bool: Whether the preheat instance is the default instance. Defaults to false.
Description string: The description of the preheat instance. Defaults to an empty string.
Enabled bool: Whether the preheat instance is enabled. Defaults to true.
Endpoint string: The endpoint of the preheat instance.
Insecure bool: Whether to allow insecure connections to the preheat instance. Defaults to false.
Name string: The name of the preheat instance.
Password string: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
Token string: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
Username string: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
Vendor string: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".

AuthMode string: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
Default bool: Whether the preheat instance is the default instance. Defaults to false.
Description string: The description of the preheat instance. Defaults to an empty string.
Enabled bool: Whether the preheat instance is enabled. Defaults to true.
Endpoint string: The endpoint of the preheat instance.
Insecure bool: Whether to allow insecure connections to the preheat instance. Defaults to false.
Name string: The name of the preheat instance.
Password string: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
Token string: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
Username string: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
Vendor string: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".

authMode String: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
default_ Boolean: Whether the preheat instance is the default instance. Defaults to false.
description String: The description of the preheat instance. Defaults to an empty string.
enabled Boolean: Whether the preheat instance is enabled. Defaults to true.
endpoint String: The endpoint of the preheat instance.
insecure Boolean: Whether to allow insecure connections to the preheat instance. Defaults to false.
name String: The name of the preheat instance.
password String: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
token String: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
username String: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
vendor String: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".

authMode string: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
default boolean: Whether the preheat instance is the default instance. Defaults to false.
description string: The description of the preheat instance. Defaults to an empty string.
enabled boolean: Whether the preheat instance is enabled. Defaults to true.
endpoint string: The endpoint of the preheat instance.
insecure boolean: Whether to allow insecure connections to the preheat instance. Defaults to false.
name string: The name of the preheat instance.
password string: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
token string: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
username string: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
vendor string: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".

auth_mode str: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
default bool: Whether the preheat instance is the default instance. Defaults to false.
description str: The description of the preheat instance. Defaults to an empty string.
enabled bool: Whether the preheat instance is enabled. Defaults to true.
endpoint str: The endpoint of the preheat instance.
insecure bool: Whether to allow insecure connections to the preheat instance. Defaults to false.
name str: The name of the preheat instance.
password str: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
token str: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
username str: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
vendor str: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".

authMode String: The authentication mode for the preheat instance. Must be either "NONE", "BASIC", or "OAUTH". Defaults to "NONE".
default Boolean: Whether the preheat instance is the default instance. Defaults to false.
description String: The description of the preheat instance. Defaults to an empty string.
enabled Boolean: Whether the preheat instance is enabled. Defaults to true.
endpoint String: The endpoint of the preheat instance.
insecure Boolean: Whether to allow insecure connections to the preheat instance. Defaults to false.
name String: The name of the preheat instance.
password String: The password for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
token String: The token for the preheat instance. Required if auth_mode is "OAUTH". Defaults to an empty string.
username String: The username for the preheat instance. Required if auth_mode is "BASIC". Defaults to an empty string.
vendor String: The vendor of the preheat instance. Must be either "dragonfly" or "kraken".

Import

The harbor_preheat_instance resource can be imported using the preheat instance ID.

$ pulumi import harbor:index/preheatInstance:PreheatInstance example /p2p/preheat/instances/example-preheat-instance

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

Package Details

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

Harbor v3.10.15 published on Saturday, Sep 28, 2024 by Pulumiverse

pulumiverse/pulumi-harbor

harbor.PreheatInstance

On this page

On this page

Example Usage

Basic Usage

Usage with Authentication

Create PreheatInstance Resource

Constructor syntax

Parameters

Constructor example

PreheatInstance Resource Properties

Inputs

Outputs

Look up Existing PreheatInstance Resource

Import

Package Details

On this page

On this page