scm.HttpHeaderProfile
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.HttpHeaderProfile("example", {});
import pulumi
import pulumi_scm as scm
example = scm.HttpHeaderProfile("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.NewHttpHeaderProfile(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.HttpHeaderProfile("example");
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.HttpHeaderProfile;
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 HttpHeaderProfile("example");
    }
}
resources:
  example:
    type: scm:HttpHeaderProfile
Create HttpHeaderProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HttpHeaderProfile(name: string, args?: HttpHeaderProfileArgs, opts?: CustomResourceOptions);@overload
def HttpHeaderProfile(resource_name: str,
                      args: Optional[HttpHeaderProfileArgs] = None,
                      opts: Optional[ResourceOptions] = None)
@overload
def HttpHeaderProfile(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      device: Optional[str] = None,
                      folder: Optional[str] = None,
                      http_header_insertions: Optional[Sequence[HttpHeaderProfileHttpHeaderInsertionArgs]] = None,
                      name: Optional[str] = None,
                      snippet: Optional[str] = None)func NewHttpHeaderProfile(ctx *Context, name string, args *HttpHeaderProfileArgs, opts ...ResourceOption) (*HttpHeaderProfile, error)public HttpHeaderProfile(string name, HttpHeaderProfileArgs? args = null, CustomResourceOptions? opts = null)
public HttpHeaderProfile(String name, HttpHeaderProfileArgs args)
public HttpHeaderProfile(String name, HttpHeaderProfileArgs args, CustomResourceOptions options)
type: scm:HttpHeaderProfile
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 HttpHeaderProfileArgs
- 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 HttpHeaderProfileArgs
- 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 HttpHeaderProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HttpHeaderProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HttpHeaderProfileArgs
- 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 httpHeaderProfileResource = new Scm.HttpHeaderProfile("httpHeaderProfileResource", new()
{
    Description = "string",
    Device = "string",
    Folder = "string",
    HttpHeaderInsertions = new[]
    {
        new Scm.Inputs.HttpHeaderProfileHttpHeaderInsertionArgs
        {
            Name = "string",
            Types = new[]
            {
                new Scm.Inputs.HttpHeaderProfileHttpHeaderInsertionTypeArgs
                {
                    Domains = new[]
                    {
                        "string",
                    },
                    Headers = new[]
                    {
                        new Scm.Inputs.HttpHeaderProfileHttpHeaderInsertionTypeHeaderArgs
                        {
                            Header = "string",
                            Name = "string",
                            Value = "string",
                            Log = false,
                        },
                    },
                    Name = "string",
                },
            },
        },
    },
    Name = "string",
    Snippet = "string",
});
example, err := scm.NewHttpHeaderProfile(ctx, "httpHeaderProfileResource", &scm.HttpHeaderProfileArgs{
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
	Folder:      pulumi.String("string"),
	HttpHeaderInsertions: scm.HttpHeaderProfileHttpHeaderInsertionArray{
		&scm.HttpHeaderProfileHttpHeaderInsertionArgs{
			Name: pulumi.String("string"),
			Types: scm.HttpHeaderProfileHttpHeaderInsertionTypeArray{
				&scm.HttpHeaderProfileHttpHeaderInsertionTypeArgs{
					Domains: pulumi.StringArray{
						pulumi.String("string"),
					},
					Headers: scm.HttpHeaderProfileHttpHeaderInsertionTypeHeaderArray{
						&scm.HttpHeaderProfileHttpHeaderInsertionTypeHeaderArgs{
							Header: pulumi.String("string"),
							Name:   pulumi.String("string"),
							Value:  pulumi.String("string"),
							Log:    pulumi.Bool(false),
						},
					},
					Name: pulumi.String("string"),
				},
			},
		},
	},
	Name:    pulumi.String("string"),
	Snippet: pulumi.String("string"),
})
var httpHeaderProfileResource = new HttpHeaderProfile("httpHeaderProfileResource", HttpHeaderProfileArgs.builder()
    .description("string")
    .device("string")
    .folder("string")
    .httpHeaderInsertions(HttpHeaderProfileHttpHeaderInsertionArgs.builder()
        .name("string")
        .types(HttpHeaderProfileHttpHeaderInsertionTypeArgs.builder()
            .domains("string")
            .headers(HttpHeaderProfileHttpHeaderInsertionTypeHeaderArgs.builder()
                .header("string")
                .name("string")
                .value("string")
                .log(false)
                .build())
            .name("string")
            .build())
        .build())
    .name("string")
    .snippet("string")
    .build());
http_header_profile_resource = scm.HttpHeaderProfile("httpHeaderProfileResource",
    description="string",
    device="string",
    folder="string",
    http_header_insertions=[{
        "name": "string",
        "types": [{
            "domains": ["string"],
            "headers": [{
                "header": "string",
                "name": "string",
                "value": "string",
                "log": False,
            }],
            "name": "string",
        }],
    }],
    name="string",
    snippet="string")
const httpHeaderProfileResource = new scm.HttpHeaderProfile("httpHeaderProfileResource", {
    description: "string",
    device: "string",
    folder: "string",
    httpHeaderInsertions: [{
        name: "string",
        types: [{
            domains: ["string"],
            headers: [{
                header: "string",
                name: "string",
                value: "string",
                log: false,
            }],
            name: "string",
        }],
    }],
    name: "string",
    snippet: "string",
});
type: scm:HttpHeaderProfile
properties:
    description: string
    device: string
    folder: string
    httpHeaderInsertions:
        - name: string
          types:
            - domains:
                - string
              headers:
                - header: string
                  log: false
                  name: string
                  value: string
              name: string
    name: string
    snippet: string
HttpHeaderProfile 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 HttpHeaderProfile resource accepts the following input properties:
- Description string
- The Description param.
- Device string
- The Device param.
- Folder string
- The Folder param.
- HttpHeader List<HttpInsertions Header Profile Http Header Insertion> 
- The HttpHeaderInsertions param.
- Name string
- The Name param.
- Snippet string
- The Snippet param.
- Description string
- The Description param.
- Device string
- The Device param.
- Folder string
- The Folder param.
- HttpHeader []HttpInsertions Header Profile Http Header Insertion Args 
- The HttpHeaderInsertions param.
- Name string
- The Name param.
- Snippet string
- The Snippet param.
- description String
- The Description param.
- device String
- The Device param.
- folder String
- The Folder param.
- httpHeader List<HttpInsertions Header Profile Http Header Insertion> 
- The HttpHeaderInsertions param.
- name String
- The Name param.
- snippet String
- The Snippet param.
- description string
- The Description param.
- device string
- The Device param.
- folder string
- The Folder param.
- httpHeader HttpInsertions Header Profile Http Header Insertion[] 
- The HttpHeaderInsertions param.
- name string
- The Name param.
- snippet string
- The Snippet param.
- description str
- The Description param.
- device str
- The Device param.
- folder str
- The Folder param.
- http_header_ Sequence[Httpinsertions Header Profile Http Header Insertion Args] 
- The HttpHeaderInsertions param.
- name str
- The Name param.
- snippet str
- The Snippet param.
- description String
- The Description param.
- device String
- The Device param.
- folder String
- The Folder param.
- httpHeader List<Property Map>Insertions 
- The HttpHeaderInsertions param.
- name String
- The Name param.
- snippet String
- The Snippet param.
Outputs
All input properties are implicitly available as output properties. Additionally, the HttpHeaderProfile resource produces the following output properties:
Look up Existing HttpHeaderProfile Resource
Get an existing HttpHeaderProfile 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?: HttpHeaderProfileState, opts?: CustomResourceOptions): HttpHeaderProfile@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        folder: Optional[str] = None,
        http_header_insertions: Optional[Sequence[HttpHeaderProfileHttpHeaderInsertionArgs]] = None,
        name: Optional[str] = None,
        snippet: Optional[str] = None,
        tfid: Optional[str] = None) -> HttpHeaderProfilefunc GetHttpHeaderProfile(ctx *Context, name string, id IDInput, state *HttpHeaderProfileState, opts ...ResourceOption) (*HttpHeaderProfile, error)public static HttpHeaderProfile Get(string name, Input<string> id, HttpHeaderProfileState? state, CustomResourceOptions? opts = null)public static HttpHeaderProfile get(String name, Output<String> id, HttpHeaderProfileState state, CustomResourceOptions options)resources:  _:    type: scm:HttpHeaderProfile    get:      id: ${id}- 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.
- Device string
- The Device param.
- Folder string
- The Folder param.
- HttpHeader List<HttpInsertions Header Profile Http Header Insertion> 
- The HttpHeaderInsertions param.
- Name string
- The Name param.
- Snippet string
- The Snippet param.
- Tfid string
- Description string
- The Description param.
- Device string
- The Device param.
- Folder string
- The Folder param.
- HttpHeader []HttpInsertions Header Profile Http Header Insertion Args 
- The HttpHeaderInsertions param.
- Name string
- The Name param.
- Snippet string
- The Snippet param.
- Tfid string
- description String
- The Description param.
- device String
- The Device param.
- folder String
- The Folder param.
- httpHeader List<HttpInsertions Header Profile Http Header Insertion> 
- The HttpHeaderInsertions param.
- name String
- The Name param.
- snippet String
- The Snippet param.
- tfid String
- description string
- The Description param.
- device string
- The Device param.
- folder string
- The Folder param.
- httpHeader HttpInsertions Header Profile Http Header Insertion[] 
- The HttpHeaderInsertions param.
- name string
- The Name param.
- snippet string
- The Snippet param.
- tfid string
- description str
- The Description param.
- device str
- The Device param.
- folder str
- The Folder param.
- http_header_ Sequence[Httpinsertions Header Profile Http Header Insertion Args] 
- The HttpHeaderInsertions param.
- name str
- The Name param.
- snippet str
- The Snippet param.
- tfid str
- description String
- The Description param.
- device String
- The Device param.
- folder String
- The Folder param.
- httpHeader List<Property Map>Insertions 
- The HttpHeaderInsertions param.
- name String
- The Name param.
- snippet String
- The Snippet param.
- tfid String
Supporting Types
HttpHeaderProfileHttpHeaderInsertion, HttpHeaderProfileHttpHeaderInsertionArgs            
- Name string
- The Name param.
- Types
List<HttpHeader Profile Http Header Insertion Type> 
- The Types param.
- Name string
- The Name param.
- Types
[]HttpHeader Profile Http Header Insertion Type 
- The Types param.
- name String
- The Name param.
- types
List<HttpHeader Profile Http Header Insertion Type> 
- The Types param.
- name string
- The Name param.
- types
HttpHeader Profile Http Header Insertion Type[] 
- The Types param.
- name str
- The Name param.
- types
Sequence[HttpHeader Profile Http Header Insertion Type] 
- The Types param.
- name String
- The Name param.
- types List<Property Map>
- The Types param.
HttpHeaderProfileHttpHeaderInsertionType, HttpHeaderProfileHttpHeaderInsertionTypeArgs              
- Domains List<string>
- The Domains param.
- Headers
List<HttpHeader Profile Http Header Insertion Type Header> 
- The Headers param.
- Name string
- The Name param.
- Domains []string
- The Domains param.
- Headers
[]HttpHeader Profile Http Header Insertion Type Header 
- The Headers param.
- Name string
- The Name param.
- domains List<String>
- The Domains param.
- headers
List<HttpHeader Profile Http Header Insertion Type Header> 
- The Headers param.
- name String
- The Name param.
- domains string[]
- The Domains param.
- headers
HttpHeader Profile Http Header Insertion Type Header[] 
- The Headers param.
- name string
- The Name param.
- domains Sequence[str]
- The Domains param.
- headers
Sequence[HttpHeader Profile Http Header Insertion Type Header] 
- The Headers param.
- name str
- The Name param.
- domains List<String>
- The Domains param.
- headers List<Property Map>
- The Headers param.
- name String
- The Name param.
HttpHeaderProfileHttpHeaderInsertionTypeHeader, HttpHeaderProfileHttpHeaderInsertionTypeHeaderArgs                
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the scmTerraform Provider.
