1. Packages
  2. Volcengine
  3. API Docs
  4. cr
  5. Endpoint
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

volcengine.cr.Endpoint

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

    Provides a resource to manage cr endpoint

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Volcengine.Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Volcengine.Cr.Endpoint("default", new()
        {
            Enabled = true,
            Registry = "acc-test-cr",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/cr"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cr.NewEndpoint(ctx, "default", &cr.EndpointArgs{
    			Enabled:  pulumi.Bool(true),
    			Registry: pulumi.String("acc-test-cr"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.cr.Endpoint;
    import com.pulumi.volcengine.cr.EndpointArgs;
    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 default_ = new Endpoint("default", EndpointArgs.builder()        
                .enabled(true)
                .registry("acc-test-cr")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    default = volcengine.cr.Endpoint("default",
        enabled=True,
        registry="acc-test-cr")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const _default = new volcengine.cr.Endpoint("default", {
        enabled: true,
        registry: "acc-test-cr",
    });
    
    resources:
      default:
        type: volcengine:cr:Endpoint
        properties:
          enabled: true
          registry: acc-test-cr
    

    Create Endpoint Resource

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

    Constructor syntax

    new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
    @overload
    def Endpoint(resource_name: str,
                 args: EndpointArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Endpoint(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 registry: Optional[str] = None,
                 enabled: Optional[bool] = None)
    func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
    public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
    public Endpoint(String name, EndpointArgs args)
    public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)
    
    type: volcengine:cr:Endpoint
    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 EndpointArgs
    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 EndpointArgs
    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 EndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var endpointResource = new Volcengine.Cr.Endpoint("endpointResource", new()
    {
        Registry = "string",
        Enabled = false,
    });
    
    example, err := cr.NewEndpoint(ctx, "endpointResource", &cr.EndpointArgs{
    	Registry: pulumi.String("string"),
    	Enabled:  pulumi.Bool(false),
    })
    
    var endpointResource = new Endpoint("endpointResource", EndpointArgs.builder()
        .registry("string")
        .enabled(false)
        .build());
    
    endpoint_resource = volcengine.cr.Endpoint("endpointResource",
        registry="string",
        enabled=False)
    
    const endpointResource = new volcengine.cr.Endpoint("endpointResource", {
        registry: "string",
        enabled: false,
    });
    
    type: volcengine:cr:Endpoint
    properties:
        enabled: false
        registry: string
    

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

    Registry string
    The CrRegistry name.
    Enabled bool
    Whether enable public endpoint.
    Registry string
    The CrRegistry name.
    Enabled bool
    Whether enable public endpoint.
    registry String
    The CrRegistry name.
    enabled Boolean
    Whether enable public endpoint.
    registry string
    The CrRegistry name.
    enabled boolean
    Whether enable public endpoint.
    registry str
    The CrRegistry name.
    enabled bool
    Whether enable public endpoint.
    registry String
    The CrRegistry name.
    enabled Boolean
    Whether enable public endpoint.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of public endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of public endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of public endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of public endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of public endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of public endpoint.

    Look up Existing Endpoint Resource

    Get an existing Endpoint 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?: EndpointState, opts?: CustomResourceOptions): Endpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            registry: Optional[str] = None,
            status: Optional[str] = None) -> Endpoint
    func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)
    public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)
    public static Endpoint get(String name, Output<String> id, EndpointState 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:
    Enabled bool
    Whether enable public endpoint.
    Registry string
    The CrRegistry name.
    Status string
    The status of public endpoint.
    Enabled bool
    Whether enable public endpoint.
    Registry string
    The CrRegistry name.
    Status string
    The status of public endpoint.
    enabled Boolean
    Whether enable public endpoint.
    registry String
    The CrRegistry name.
    status String
    The status of public endpoint.
    enabled boolean
    Whether enable public endpoint.
    registry string
    The CrRegistry name.
    status string
    The status of public endpoint.
    enabled bool
    Whether enable public endpoint.
    registry str
    The CrRegistry name.
    status str
    The status of public endpoint.
    enabled Boolean
    Whether enable public endpoint.
    registry String
    The CrRegistry name.
    status String
    The status of public endpoint.

    Import

    CR endpoints can be imported using the endpoint:registryName, e.g.

     $ pulumi import volcengine:cr/endpoint:Endpoint default endpoint:cr-basic
    

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine