Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. CustomLocation
Control Plane v0.0.47 published on Saturday, Nov 9, 2024 by pulumiverse
pulumiverse/pulumi-cpln

cpln.CustomLocation

Explore with Pulumi AI

cpln logo
Control Plane v0.0.47 published on Saturday, Nov 9, 2024 by pulumiverse
pulumiverse/pulumi-cpln

    Create CustomLocation Resource

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

    Constructor syntax

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

@overload
def CustomLocation(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cloud_provider: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewCustomLocation(ctx *Context, name string, args CustomLocationArgs, opts ...ResourceOption) (*CustomLocation, error)
    public CustomLocation(string name, CustomLocationArgs args, CustomResourceOptions? opts = null)
    public CustomLocation(String name, CustomLocationArgs args)
public CustomLocation(String name, CustomLocationArgs args, CustomResourceOptions options)

    type: cpln:CustomLocation
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 CustomLocationArgs
    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 CustomLocationArgs
    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 CustomLocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomLocationArgs
    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 customLocationResource = new Cpln.CustomLocation("customLocationResource", new()
{
    CloudProvider = "string",
    Enabled = false,
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cpln.NewCustomLocation(ctx, "customLocationResource", &cpln.CustomLocationArgs{
	CloudProvider: pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	Description:   pulumi.String("string"),
	Name:          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var customLocationResource = new CustomLocation("customLocationResource", CustomLocationArgs.builder()
    .cloudProvider("string")
    .enabled(false)
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    custom_location_resource = cpln.CustomLocation("customLocationResource",
    cloud_provider="string",
    enabled=False,
    description="string",
    name="string",
    tags={
        "string": "string",
    })

    const customLocationResource = new cpln.CustomLocation("customLocationResource", {
    cloudProvider: "string",
    enabled: false,
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: cpln:CustomLocation
properties:
    cloudProvider: string
    description: string
    enabled: false
    name: string
    tags:
        string: string

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

    CloudProvider string
    Cloud Provider of the custom location.
    Enabled bool
    Indication if the custom location is enabled.
    Description string
    Description of the custom location.
    Name string
    Name of the custom location.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    CloudProvider string
    Cloud Provider of the custom location.
    Enabled bool
    Indication if the custom location is enabled.
    Description string
    Description of the custom location.
    Name string
    Name of the custom location.
    Tags map[string]string
    Key-value map of resource tags.
    cloudProvider String
    Cloud Provider of the custom location.
    enabled Boolean
    Indication if the custom location is enabled.
    description String
    Description of the custom location.
    name String
    Name of the custom location.
    tags Map<String,String>
    Key-value map of resource tags.
    cloudProvider string
    Cloud Provider of the custom location.
    enabled boolean
    Indication if the custom location is enabled.
    description string
    Description of the custom location.
    name string
    Name of the custom location.
    tags {[key: string]: string}
    Key-value map of resource tags.
    cloud_provider str
    Cloud Provider of the custom location.
    enabled bool
    Indication if the custom location is enabled.
    description str
    Description of the custom location.
    name str
    Name of the custom location.
    tags Mapping[str, str]
    Key-value map of resource tags.
    cloudProvider String
    Cloud Provider of the custom location.
    enabled Boolean
    Indication if the custom location is enabled.
    description String
    Description of the custom location.
    name String
    Name of the custom location.
    tags Map<String>
    Key-value map of resource tags.

    Outputs

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

    CplnId string
    The ID, in GUID format, of the custom location.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    CplnId string
    The ID, in GUID format, of the custom location.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    cplnId String
    The ID, in GUID format, of the custom location.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    cplnId string
    The ID, in GUID format, of the custom location.
    id string
    The provider-assigned unique ID for this managed resource.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    cpln_id str
    The ID, in GUID format, of the custom location.
    id str
    The provider-assigned unique ID for this managed resource.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    cplnId String
    The ID, in GUID format, of the custom location.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.

    Look up Existing CustomLocation Resource

    Get an existing CustomLocation 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?: CustomLocationState, opts?: CustomResourceOptions): CustomLocation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_provider: Optional[str] = None,
        cpln_id: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        self_link: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> CustomLocation
    func GetCustomLocation(ctx *Context, name string, id IDInput, state *CustomLocationState, opts ...ResourceOption) (*CustomLocation, error)
    public static CustomLocation Get(string name, Input<string> id, CustomLocationState? state, CustomResourceOptions? opts = null)
    public static CustomLocation get(String name, Output<String> id, CustomLocationState 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:
    CloudProvider string
    Cloud Provider of the custom location.
    CplnId string
    The ID, in GUID format, of the custom location.
    Description string
    Description of the custom location.
    Enabled bool
    Indication if the custom location is enabled.
    Name string
    Name of the custom location.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    CloudProvider string
    Cloud Provider of the custom location.
    CplnId string
    The ID, in GUID format, of the custom location.
    Description string
    Description of the custom location.
    Enabled bool
    Indication if the custom location is enabled.
    Name string
    Name of the custom location.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Tags map[string]string
    Key-value map of resource tags.
    cloudProvider String
    Cloud Provider of the custom location.
    cplnId String
    The ID, in GUID format, of the custom location.
    description String
    Description of the custom location.
    enabled Boolean
    Indication if the custom location is enabled.
    name String
    Name of the custom location.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    tags Map<String,String>
    Key-value map of resource tags.
    cloudProvider string
    Cloud Provider of the custom location.
    cplnId string
    The ID, in GUID format, of the custom location.
    description string
    Description of the custom location.
    enabled boolean
    Indication if the custom location is enabled.
    name string
    Name of the custom location.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    tags {[key: string]: string}
    Key-value map of resource tags.
    cloud_provider str
    Cloud Provider of the custom location.
    cpln_id str
    The ID, in GUID format, of the custom location.
    description str
    Description of the custom location.
    enabled bool
    Indication if the custom location is enabled.
    name str
    Name of the custom location.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    tags Mapping[str, str]
    Key-value map of resource tags.
    cloudProvider String
    Cloud Provider of the custom location.
    cplnId String
    The ID, in GUID format, of the custom location.
    description String
    Description of the custom location.
    enabled Boolean
    Indication if the custom location is enabled.
    name String
    Name of the custom location.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    tags Map<String>
    Key-value map of resource tags.

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Control Plane v0.0.47 published on Saturday, Nov 9, 2024 by pulumiverse
    pulumiverse/pulumi-cpln