1. Packages
  2. Artifactory
  3. API Docs
  4. GlobalEnvironment
artifactory v6.8.4 published on Thursday, Jun 6, 2024 by Pulumi

artifactory.GlobalEnvironment

Explore with Pulumi AI

artifactory logo
artifactory v6.8.4 published on Thursday, Jun 6, 2024 by Pulumi

    Provides a global environment resource. This can be used to create and manage global environment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as artifactory from "@pulumi/artifactory";
    
    const test_env = new artifactory.GlobalEnvironment("test-env", {name: "test-env"});
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    test_env = artifactory.GlobalEnvironment("test-env", name="test-env")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-artifactory/sdk/v6/go/artifactory"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := artifactory.NewGlobalEnvironment(ctx, "test-env", &artifactory.GlobalEnvironmentArgs{
    			Name: pulumi.String("test-env"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Artifactory = Pulumi.Artifactory;
    
    return await Deployment.RunAsync(() => 
    {
        var test_env = new Artifactory.GlobalEnvironment("test-env", new()
        {
            Name = "test-env",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.artifactory.GlobalEnvironment;
    import com.pulumi.artifactory.GlobalEnvironmentArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test_env = new GlobalEnvironment("test-env", GlobalEnvironmentArgs.builder()
                .name("test-env")
                .build());
    
        }
    }
    
    resources:
      test-env:
        type: artifactory:GlobalEnvironment
        properties:
          name: test-env
    

    Create GlobalEnvironment Resource

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

    Constructor syntax

    new GlobalEnvironment(name: string, args?: GlobalEnvironmentArgs, opts?: CustomResourceOptions);
    @overload
    def GlobalEnvironment(resource_name: str,
                          args: Optional[GlobalEnvironmentArgs] = None,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def GlobalEnvironment(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          name: Optional[str] = None)
    func NewGlobalEnvironment(ctx *Context, name string, args *GlobalEnvironmentArgs, opts ...ResourceOption) (*GlobalEnvironment, error)
    public GlobalEnvironment(string name, GlobalEnvironmentArgs? args = null, CustomResourceOptions? opts = null)
    public GlobalEnvironment(String name, GlobalEnvironmentArgs args)
    public GlobalEnvironment(String name, GlobalEnvironmentArgs args, CustomResourceOptions options)
    
    type: artifactory:GlobalEnvironment
    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 GlobalEnvironmentArgs
    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 GlobalEnvironmentArgs
    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 GlobalEnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalEnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalEnvironmentArgs
    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 globalEnvironmentResource = new Artifactory.GlobalEnvironment("globalEnvironmentResource", new()
    {
        Name = "string",
    });
    
    example, err := artifactory.NewGlobalEnvironment(ctx, "globalEnvironmentResource", &artifactory.GlobalEnvironmentArgs{
    	Name: pulumi.String("string"),
    })
    
    var globalEnvironmentResource = new GlobalEnvironment("globalEnvironmentResource", GlobalEnvironmentArgs.builder()
        .name("string")
        .build());
    
    global_environment_resource = artifactory.GlobalEnvironment("globalEnvironmentResource", name="string")
    
    const globalEnvironmentResource = new artifactory.GlobalEnvironment("globalEnvironmentResource", {name: "string"});
    
    type: artifactory:GlobalEnvironment
    properties:
        name: string
    

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

    Name string
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    Name string
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    name String
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    name string
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    name str
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    name String
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters

    Outputs

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

    Get an existing GlobalEnvironment 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?: GlobalEnvironmentState, opts?: CustomResourceOptions): GlobalEnvironment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None) -> GlobalEnvironment
    func GetGlobalEnvironment(ctx *Context, name string, id IDInput, state *GlobalEnvironmentState, opts ...ResourceOption) (*GlobalEnvironment, error)
    public static GlobalEnvironment Get(string name, Input<string> id, GlobalEnvironmentState? state, CustomResourceOptions? opts = null)
    public static GlobalEnvironment get(String name, Output<String> id, GlobalEnvironmentState 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:
    Name string
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    Name string
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    name String
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    name string
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    name str
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters
    name String
    Name must start with a letter and contain letters, digits and - character. The maximum length is 32 characters

    Import

    $ pulumi import artifactory:index/globalEnvironment:GlobalEnvironment dev-env myenv
    

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

    Package Details

    Repository
    artifactory pulumi/pulumi-artifactory
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the artifactory Terraform Provider.
    artifactory logo
    artifactory v6.8.4 published on Thursday, Jun 6, 2024 by Pulumi