scm.HipProfile
Explore with Pulumi AI
Retrieves a config item.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
const example = new scm.HipProfile("example", {});
import pulumi
import pulumi_scm as scm
example = scm.HipProfile("example")
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := scm.NewHipProfile(ctx, "example", nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
var example = new Scm.HipProfile("example");
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.HipProfile;
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 example = new HipProfile("example");
}
}
resources:
example:
type: scm:HipProfile
Create HipProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HipProfile(name: string, args: HipProfileArgs, opts?: CustomResourceOptions);
@overload
def HipProfile(resource_name: str,
args: HipProfileArgs,
opts: Optional[ResourceOptions] = None)
@overload
def HipProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
match: Optional[str] = None,
description: Optional[str] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
snippet: Optional[str] = None)
func NewHipProfile(ctx *Context, name string, args HipProfileArgs, opts ...ResourceOption) (*HipProfile, error)
public HipProfile(string name, HipProfileArgs args, CustomResourceOptions? opts = null)
public HipProfile(String name, HipProfileArgs args)
public HipProfile(String name, HipProfileArgs args, CustomResourceOptions options)
type: scm:HipProfile
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 HipProfileArgs
- 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 HipProfileArgs
- 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 HipProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HipProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HipProfileArgs
- 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 hipProfileResource = new Scm.HipProfile("hipProfileResource", new()
{
Match = "string",
Description = "string",
Device = "string",
Folder = "string",
Name = "string",
Snippet = "string",
});
example, err := scm.NewHipProfile(ctx, "hipProfileResource", &scm.HipProfileArgs{
Match: pulumi.String("string"),
Description: pulumi.String("string"),
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
Name: pulumi.String("string"),
Snippet: pulumi.String("string"),
})
var hipProfileResource = new HipProfile("hipProfileResource", HipProfileArgs.builder()
.match("string")
.description("string")
.device("string")
.folder("string")
.name("string")
.snippet("string")
.build());
hip_profile_resource = scm.HipProfile("hipProfileResource",
match="string",
description="string",
device="string",
folder="string",
name="string",
snippet="string")
const hipProfileResource = new scm.HipProfile("hipProfileResource", {
match: "string",
description: "string",
device: "string",
folder: "string",
name: "string",
snippet: "string",
});
type: scm:HipProfile
properties:
description: string
device: string
folder: string
match: string
name: string
snippet: string
HipProfile 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 HipProfile resource accepts the following input properties:
- Match string
- The Match param. String length must not exceed 2048 characters.
- Description string
- The Description param. String length must not exceed 255 characters.
- Device string
- The Device param.
- Folder string
- The Folder param.
- Name string
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- Snippet string
- The Snippet param.
- Match string
- The Match param. String length must not exceed 2048 characters.
- Description string
- The Description param. String length must not exceed 255 characters.
- Device string
- The Device param.
- Folder string
- The Folder param.
- Name string
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- Snippet string
- The Snippet param.
- match String
- The Match param. String length must not exceed 2048 characters.
- description String
- The Description param. String length must not exceed 255 characters.
- device String
- The Device param.
- folder String
- The Folder param.
- name String
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- snippet String
- The Snippet param.
- match string
- The Match param. String length must not exceed 2048 characters.
- description string
- The Description param. String length must not exceed 255 characters.
- device string
- The Device param.
- folder string
- The Folder param.
- name string
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- snippet string
- The Snippet param.
- match str
- The Match param. String length must not exceed 2048 characters.
- description str
- The Description param. String length must not exceed 255 characters.
- device str
- The Device param.
- folder str
- The Folder param.
- name str
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- snippet str
- The Snippet param.
- match String
- The Match param. String length must not exceed 2048 characters.
- description String
- The Description param. String length must not exceed 255 characters.
- device String
- The Device param.
- folder String
- The Folder param.
- name String
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- snippet String
- The Snippet param.
Outputs
All input properties are implicitly available as output properties. Additionally, the HipProfile resource produces the following output properties:
Look up Existing HipProfile Resource
Get an existing HipProfile 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?: HipProfileState, opts?: CustomResourceOptions): HipProfile
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
match: Optional[str] = None,
name: Optional[str] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None) -> HipProfile
func GetHipProfile(ctx *Context, name string, id IDInput, state *HipProfileState, opts ...ResourceOption) (*HipProfile, error)
public static HipProfile Get(string name, Input<string> id, HipProfileState? state, CustomResourceOptions? opts = null)
public static HipProfile get(String name, Output<String> id, HipProfileState 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.
- Description string
- The Description param. String length must not exceed 255 characters.
- Device string
- The Device param.
- Folder string
- The Folder param.
- Match string
- The Match param. String length must not exceed 2048 characters.
- Name string
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- Snippet string
- The Snippet param.
- Tfid string
- Description string
- The Description param. String length must not exceed 255 characters.
- Device string
- The Device param.
- Folder string
- The Folder param.
- Match string
- The Match param. String length must not exceed 2048 characters.
- Name string
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- Snippet string
- The Snippet param.
- Tfid string
- description String
- The Description param. String length must not exceed 255 characters.
- device String
- The Device param.
- folder String
- The Folder param.
- match String
- The Match param. String length must not exceed 2048 characters.
- name String
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- snippet String
- The Snippet param.
- tfid String
- description string
- The Description param. String length must not exceed 255 characters.
- device string
- The Device param.
- folder string
- The Folder param.
- match string
- The Match param. String length must not exceed 2048 characters.
- name string
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- snippet string
- The Snippet param.
- tfid string
- description str
- The Description param. String length must not exceed 255 characters.
- device str
- The Device param.
- folder str
- The Folder param.
- match str
- The Match param. String length must not exceed 2048 characters.
- name str
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- snippet str
- The Snippet param.
- tfid str
- description String
- The Description param. String length must not exceed 255 characters.
- device String
- The Device param.
- folder String
- The Folder param.
- match String
- The Match param. String length must not exceed 2048 characters.
- name String
- Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
- snippet String
- The Snippet param.
- tfid String
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scm
Terraform Provider.