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

harness.platform.Provider

Explore with Pulumi AI

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

    Create Provider Resource

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

    Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             identifier: Optional[str] = None,
             spec: Optional[ProviderSpecArgs] = None,
             description: Optional[str] = None,
             name: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: harness:platform:Provider
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 ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    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 providerResource = new Harness.Platform.Provider("providerResource", new()
{
    Identifier = "string",
    Spec = new Harness.Platform.Inputs.ProviderSpecArgs
    {
        Type = "string",
        ClientId = "string",
        ClientSecretRef = "string",
        DelegateSelectors = new[]
        {
            "string",
        },
        Domain = "string",
        SecretManagerRef = "string",
    },
    Description = "string",
    Name = "string",
});

    example, err := platform.NewProvider(ctx, "providerResource", &platform.ProviderArgs{
	Identifier: pulumi.String("string"),
	Spec: &platform.ProviderSpecArgs{
		Type:            pulumi.String("string"),
		ClientId:        pulumi.String("string"),
		ClientSecretRef: pulumi.String("string"),
		DelegateSelectors: pulumi.StringArray{
			pulumi.String("string"),
		},
		Domain:           pulumi.String("string"),
		SecretManagerRef: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var providerResource = new Provider("providerResource", ProviderArgs.builder()
    .identifier("string")
    .spec(ProviderSpecArgs.builder()
        .type("string")
        .clientId("string")
        .clientSecretRef("string")
        .delegateSelectors("string")
        .domain("string")
        .secretManagerRef("string")
        .build())
    .description("string")
    .name("string")
    .build());

    provider_resource = harness.platform.Provider("providerResource",
    identifier="string",
    spec={
        "type": "string",
        "client_id": "string",
        "client_secret_ref": "string",
        "delegate_selectors": ["string"],
        "domain": "string",
        "secret_manager_ref": "string",
    },
    description="string",
    name="string")

    const providerResource = new harness.platform.Provider("providerResource", {
    identifier: "string",
    spec: {
        type: "string",
        clientId: "string",
        clientSecretRef: "string",
        delegateSelectors: ["string"],
        domain: "string",
        secretManagerRef: "string",
    },
    description: "string",
    name: "string",
});

    type: harness:platform:Provider
properties:
    description: string
    identifier: string
    name: string
    spec:
        clientId: string
        clientSecretRef: string
        delegateSelectors:
            - string
        domain: string
        secretManagerRef: string
        type: string

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

    Identifier string
    The identifier of the provider entity.
    Spec ProviderSpec
    Contains parameters related to the provider entity.
    Description string
    The description of the provider entity.
    Name string
    The name of the provider entity.
    Identifier string
    The identifier of the provider entity.
    Spec ProviderSpecArgs
    Contains parameters related to the provider entity.
    Description string
    The description of the provider entity.
    Name string
    The name of the provider entity.
    identifier String
    The identifier of the provider entity.
    spec ProviderSpec
    Contains parameters related to the provider entity.
    description String
    The description of the provider entity.
    name String
    The name of the provider entity.
    identifier string
    The identifier of the provider entity.
    spec ProviderSpec
    Contains parameters related to the provider entity.
    description string
    The description of the provider entity.
    name string
    The name of the provider entity.
    identifier str
    The identifier of the provider entity.
    spec ProviderSpecArgs
    Contains parameters related to the provider entity.
    description str
    The description of the provider entity.
    name str
    The name of the provider entity.
    identifier String
    The identifier of the provider entity.
    spec Property Map
    Contains parameters related to the provider entity.
    description String
    The description of the provider entity.
    name String
    The name of the provider entity.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt int
    The last modified time of the provider entity.
    Type string
    The type of the provider entity.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt int
    The last modified time of the provider entity.
    Type string
    The type of the provider entity.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt Integer
    The last modified time of the provider entity.
    type String
    The type of the provider entity.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt number
    The last modified time of the provider entity.
    type string
    The type of the provider entity.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_at int
    The last modified time of the provider entity.
    type str
    The type of the provider entity.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt Number
    The last modified time of the provider entity.
    type String
    The type of the provider entity.

    Look up Existing Provider Resource

    Get an existing Provider 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?: ProviderState, opts?: CustomResourceOptions): Provider
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        identifier: Optional[str] = None,
        last_modified_at: Optional[int] = None,
        name: Optional[str] = None,
        spec: Optional[ProviderSpecArgs] = None,
        type: Optional[str] = None) -> Provider
    func GetProvider(ctx *Context, name string, id IDInput, state *ProviderState, opts ...ResourceOption) (*Provider, error)
    public static Provider Get(string name, Input<string> id, ProviderState? state, CustomResourceOptions? opts = null)
    public static Provider get(String name, Output<String> id, ProviderState 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:
    Description string
    The description of the provider entity.
    Identifier string
    The identifier of the provider entity.
    LastModifiedAt int
    The last modified time of the provider entity.
    Name string
    The name of the provider entity.
    Spec ProviderSpec
    Contains parameters related to the provider entity.
    Type string
    The type of the provider entity.
    Description string
    The description of the provider entity.
    Identifier string
    The identifier of the provider entity.
    LastModifiedAt int
    The last modified time of the provider entity.
    Name string
    The name of the provider entity.
    Spec ProviderSpecArgs
    Contains parameters related to the provider entity.
    Type string
    The type of the provider entity.
    description String
    The description of the provider entity.
    identifier String
    The identifier of the provider entity.
    lastModifiedAt Integer
    The last modified time of the provider entity.
    name String
    The name of the provider entity.
    spec ProviderSpec
    Contains parameters related to the provider entity.
    type String
    The type of the provider entity.
    description string
    The description of the provider entity.
    identifier string
    The identifier of the provider entity.
    lastModifiedAt number
    The last modified time of the provider entity.
    name string
    The name of the provider entity.
    spec ProviderSpec
    Contains parameters related to the provider entity.
    type string
    The type of the provider entity.
    description str
    The description of the provider entity.
    identifier str
    The identifier of the provider entity.
    last_modified_at int
    The last modified time of the provider entity.
    name str
    The name of the provider entity.
    spec ProviderSpecArgs
    Contains parameters related to the provider entity.
    type str
    The type of the provider entity.
    description String
    The description of the provider entity.
    identifier String
    The identifier of the provider entity.
    lastModifiedAt Number
    The last modified time of the provider entity.
    name String
    The name of the provider entity.
    spec Property Map
    Contains parameters related to the provider entity.
    type String
    The type of the provider entity.

    Supporting Types

    ProviderSpec, ProviderSpecArgs

    Type string
    The type of the provider entity.
    ClientId string
    Client Id of the OAuth app to connect
    ClientSecretRef string
    Client Secret Ref of the OAuth app to connect
    DelegateSelectors List<string>
    Delegate selectors to fetch the access token
    Domain string
    Host domain of the provider.
    SecretManagerRef string
    Secret Manager Ref to store the access/refresh tokens
    Type string
    The type of the provider entity.
    ClientId string
    Client Id of the OAuth app to connect
    ClientSecretRef string
    Client Secret Ref of the OAuth app to connect
    DelegateSelectors []string
    Delegate selectors to fetch the access token
    Domain string
    Host domain of the provider.
    SecretManagerRef string
    Secret Manager Ref to store the access/refresh tokens
    type String
    The type of the provider entity.
    clientId String
    Client Id of the OAuth app to connect
    clientSecretRef String
    Client Secret Ref of the OAuth app to connect
    delegateSelectors List<String>
    Delegate selectors to fetch the access token
    domain String
    Host domain of the provider.
    secretManagerRef String
    Secret Manager Ref to store the access/refresh tokens
    type string
    The type of the provider entity.
    clientId string
    Client Id of the OAuth app to connect
    clientSecretRef string
    Client Secret Ref of the OAuth app to connect
    delegateSelectors string[]
    Delegate selectors to fetch the access token
    domain string
    Host domain of the provider.
    secretManagerRef string
    Secret Manager Ref to store the access/refresh tokens
    type str
    The type of the provider entity.
    client_id str
    Client Id of the OAuth app to connect
    client_secret_ref str
    Client Secret Ref of the OAuth app to connect
    delegate_selectors Sequence[str]
    Delegate selectors to fetch the access token
    domain str
    Host domain of the provider.
    secret_manager_ref str
    Secret Manager Ref to store the access/refresh tokens
    type String
    The type of the provider entity.
    clientId String
    Client Id of the OAuth app to connect
    clientSecretRef String
    Client Secret Ref of the OAuth app to connect
    delegateSelectors List<String>
    Delegate selectors to fetch the access token
    domain String
    Host domain of the provider.
    secretManagerRef String
    Secret Manager Ref to store the access/refresh tokens

    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