http

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 2, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

A Pulumi package for creating and managing HTTP cloud resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetHttpArgs 

type GetHttpArgs struct {
	// Certificate data of the Certificate Authority (CA) in [PEM (RFC 1421)](https://datatracker.ietf.org/doc/html/rfc1421) format.
	CaCertPem *string `pulumi:"caCertPem"`
	// Disables verification of the server's certificate chain and hostname. Defaults to `false`
	Insecure *bool `pulumi:"insecure"`
	// The HTTP Method for the request. Allowed methods are a subset of methods defined in [RFC7231](https://datatracker.ietf.org/doc/html/rfc7231#section-4.3) namely, `GET`, `HEAD`, and `POST`. `POST` support is only intended for read-only URLs, such as submitting a search.
	Method *string `pulumi:"method"`
	// The request body as a string.
	RequestBody *string `pulumi:"requestBody"`
	// A map of request header field names and values.
	RequestHeaders map[string]string `pulumi:"requestHeaders"`
	// The request timeout in milliseconds.
	RequestTimeoutMs *int          `pulumi:"requestTimeoutMs"`
	Retry            *GetHttpRetry `pulumi:"retry"`
	// The URL for the request. Supported schemes are `getHttp` and `https`.
	Url string `pulumi:"url"`
}

A collection of arguments for invoking getHttp.

type GetHttpOutputArgs 

type GetHttpOutputArgs struct {
	// Certificate data of the Certificate Authority (CA) in [PEM (RFC 1421)](https://datatracker.ietf.org/doc/html/rfc1421) format.
	CaCertPem pulumi.StringPtrInput `pulumi:"caCertPem"`
	// Disables verification of the server's certificate chain and hostname. Defaults to `false`
	Insecure pulumi.BoolPtrInput `pulumi:"insecure"`
	// The HTTP Method for the request. Allowed methods are a subset of methods defined in [RFC7231](https://datatracker.ietf.org/doc/html/rfc7231#section-4.3) namely, `GET`, `HEAD`, and `POST`. `POST` support is only intended for read-only URLs, such as submitting a search.
	Method pulumi.StringPtrInput `pulumi:"method"`
	// The request body as a string.
	RequestBody pulumi.StringPtrInput `pulumi:"requestBody"`
	// A map of request header field names and values.
	RequestHeaders pulumi.StringMapInput `pulumi:"requestHeaders"`
	// The request timeout in milliseconds.
	RequestTimeoutMs pulumi.IntPtrInput   `pulumi:"requestTimeoutMs"`
	Retry            GetHttpRetryPtrInput `pulumi:"retry"`
	// The URL for the request. Supported schemes are `getHttp` and `https`.
	Url pulumi.StringInput `pulumi:"url"`
}

A collection of arguments for invoking getHttp.

func (GetHttpOutputArgs) ElementType 

func (GetHttpOutputArgs) ElementType() reflect.Type

type GetHttpResult 

type GetHttpResult struct {
	// The response body returned as a string. **NOTE**: This is deprecated, use `responseBody` instead.
	//
	// Deprecated: Use response_body instead
	Body string `pulumi:"body"`
	// Certificate data of the Certificate Authority (CA) in [PEM (RFC 1421)](https://datatracker.ietf.org/doc/html/rfc1421) format.
	CaCertPem *string `pulumi:"caCertPem"`
	// The URL used for the request.
	Id string `pulumi:"id"`
	// Disables verification of the server's certificate chain and hostname. Defaults to `false`
	Insecure *bool `pulumi:"insecure"`
	// The HTTP Method for the request. Allowed methods are a subset of methods defined in [RFC7231](https://datatracker.ietf.org/doc/html/rfc7231#section-4.3) namely, `GET`, `HEAD`, and `POST`. `POST` support is only intended for read-only URLs, such as submitting a search.
	Method *string `pulumi:"method"`
	// The request body as a string.
	RequestBody *string `pulumi:"requestBody"`
	// A map of request header field names and values.
	RequestHeaders map[string]string `pulumi:"requestHeaders"`
	// The request timeout in milliseconds.
	RequestTimeoutMs *int `pulumi:"requestTimeoutMs"`
	// The response body returned as a string.
	ResponseBody string `pulumi:"responseBody"`
	// The response body encoded as base64 (standard) as defined in [RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648#section-4).
	ResponseBodyBase64 string `pulumi:"responseBodyBase64"`
	// A map of response header field names and values. Duplicate headers are concatenated according to [RFC2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2).
	ResponseHeaders map[string]string `pulumi:"responseHeaders"`
	Retry           *GetHttpRetry     `pulumi:"retry"`
	// The HTTP response status code.
	StatusCode int `pulumi:"statusCode"`
	// The URL for the request. Supported schemes are `getHttp` and `https`.
	Url string `pulumi:"url"`
}

A collection of values returned by getHttp.

func GetHttp 

func GetHttp(ctx *pulumi.Context, args *GetHttpArgs, opts ...pulumi.InvokeOption) (*GetHttpResult, error)

type GetHttpResultOutput 

type GetHttpResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getHttp.

func GetHttpOutput 

func GetHttpOutput(ctx *pulumi.Context, args GetHttpOutputArgs, opts ...pulumi.InvokeOption) GetHttpResultOutput

func (GetHttpResultOutput) Body deprecated 

func (o GetHttpResultOutput) Body() pulumi.StringOutput

The response body returned as a string. **NOTE**: This is deprecated, use `responseBody` instead.

Deprecated: Use response_body instead

func (GetHttpResultOutput) CaCertPem 

func (o GetHttpResultOutput) CaCertPem() pulumi.StringPtrOutput

Certificate data of the Certificate Authority (CA) in [PEM (RFC 1421)](https://datatracker.ietf.org/doc/html/rfc1421) format.

func (GetHttpResultOutput) ElementType 

func (GetHttpResultOutput) ElementType() reflect.Type

func (GetHttpResultOutput) Id 

func (o GetHttpResultOutput) Id() pulumi.StringOutput

The URL used for the request.

func (GetHttpResultOutput) Insecure 

func (o GetHttpResultOutput) Insecure() pulumi.BoolPtrOutput

Disables verification of the server's certificate chain and hostname. Defaults to `false`

func (GetHttpResultOutput) Method 

func (o GetHttpResultOutput) Method() pulumi.StringPtrOutput

The HTTP Method for the request. Allowed methods are a subset of methods defined in [RFC7231](https://datatracker.ietf.org/doc/html/rfc7231#section-4.3) namely, `GET`, `HEAD`, and `POST`. `POST` support is only intended for read-only URLs, such as submitting a search.

func (GetHttpResultOutput) RequestBody 

func (o GetHttpResultOutput) RequestBody() pulumi.StringPtrOutput

The request body as a string.

func (GetHttpResultOutput) RequestHeaders 

func (o GetHttpResultOutput) RequestHeaders() pulumi.StringMapOutput

A map of request header field names and values.

func (GetHttpResultOutput) RequestTimeoutMs 

func (o GetHttpResultOutput) RequestTimeoutMs() pulumi.IntPtrOutput

The request timeout in milliseconds.

func (GetHttpResultOutput) ResponseBody 

func (o GetHttpResultOutput) ResponseBody() pulumi.StringOutput

The response body returned as a string.

func (GetHttpResultOutput) ResponseBodyBase64 

func (o GetHttpResultOutput) ResponseBodyBase64() pulumi.StringOutput

The response body encoded as base64 (standard) as defined in [RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648#section-4).

func (GetHttpResultOutput) ResponseHeaders 

func (o GetHttpResultOutput) ResponseHeaders() pulumi.StringMapOutput

A map of response header field names and values. Duplicate headers are concatenated according to [RFC2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2).

func (GetHttpResultOutput) Retry 

func (o GetHttpResultOutput) Retry() GetHttpRetryPtrOutput

func (GetHttpResultOutput) StatusCode 

func (o GetHttpResultOutput) StatusCode() pulumi.IntOutput

The HTTP response status code.

func (GetHttpResultOutput) ToGetHttpResultOutput 

func (o GetHttpResultOutput) ToGetHttpResultOutput() GetHttpResultOutput

func (GetHttpResultOutput) ToGetHttpResultOutputWithContext 

func (o GetHttpResultOutput) ToGetHttpResultOutputWithContext(ctx context.Context) GetHttpResultOutput

func (GetHttpResultOutput) Url 

func (o GetHttpResultOutput) Url() pulumi.StringOutput

The URL for the request. Supported schemes are `getHttp` and `https`.

type GetHttpRetry 

type GetHttpRetry struct {
	// The number of times the request is to be retried. For example, if 2 is specified, the request will be tried a maximum of 3 times.
	Attempts *int `pulumi:"attempts"`
	// The maximum delay between retry requests in milliseconds.
	MaxDelayMs *int `pulumi:"maxDelayMs"`
	// The minimum delay between retry requests in milliseconds.
	MinDelayMs *int `pulumi:"minDelayMs"`
}

type GetHttpRetryArgs 

type GetHttpRetryArgs struct {
	// The number of times the request is to be retried. For example, if 2 is specified, the request will be tried a maximum of 3 times.
	Attempts pulumi.IntPtrInput `pulumi:"attempts"`
	// The maximum delay between retry requests in milliseconds.
	MaxDelayMs pulumi.IntPtrInput `pulumi:"maxDelayMs"`
	// The minimum delay between retry requests in milliseconds.
	MinDelayMs pulumi.IntPtrInput `pulumi:"minDelayMs"`
}

func (GetHttpRetryArgs) ElementType 

func (GetHttpRetryArgs) ElementType() reflect.Type

func (GetHttpRetryArgs) ToGetHttpRetryOutput 

func (i GetHttpRetryArgs) ToGetHttpRetryOutput() GetHttpRetryOutput

func (GetHttpRetryArgs) ToGetHttpRetryOutputWithContext 

func (i GetHttpRetryArgs) ToGetHttpRetryOutputWithContext(ctx context.Context) GetHttpRetryOutput

func (GetHttpRetryArgs) ToGetHttpRetryPtrOutput 

func (i GetHttpRetryArgs) ToGetHttpRetryPtrOutput() GetHttpRetryPtrOutput

func (GetHttpRetryArgs) ToGetHttpRetryPtrOutputWithContext 

func (i GetHttpRetryArgs) ToGetHttpRetryPtrOutputWithContext(ctx context.Context) GetHttpRetryPtrOutput

type GetHttpRetryInput 

type GetHttpRetryInput interface {
	pulumi.Input

	ToGetHttpRetryOutput() GetHttpRetryOutput
	ToGetHttpRetryOutputWithContext(context.Context) GetHttpRetryOutput
}

GetHttpRetryInput is an input type that accepts GetHttpRetryArgs and GetHttpRetryOutput values. You can construct a concrete instance of `GetHttpRetryInput` via: 

GetHttpRetryArgs{...}

type GetHttpRetryOutput 

type GetHttpRetryOutput struct{ *pulumi.OutputState }

func (GetHttpRetryOutput) Attempts 

func (o GetHttpRetryOutput) Attempts() pulumi.IntPtrOutput

The number of times the request is to be retried. For example, if 2 is specified, the request will be tried a maximum of 3 times.

func (GetHttpRetryOutput) ElementType 

func (GetHttpRetryOutput) ElementType() reflect.Type

func (GetHttpRetryOutput) MaxDelayMs 

func (o GetHttpRetryOutput) MaxDelayMs() pulumi.IntPtrOutput

The maximum delay between retry requests in milliseconds.

func (GetHttpRetryOutput) MinDelayMs 

func (o GetHttpRetryOutput) MinDelayMs() pulumi.IntPtrOutput

The minimum delay between retry requests in milliseconds.

func (GetHttpRetryOutput) ToGetHttpRetryOutput 

func (o GetHttpRetryOutput) ToGetHttpRetryOutput() GetHttpRetryOutput

func (GetHttpRetryOutput) ToGetHttpRetryOutputWithContext 

func (o GetHttpRetryOutput) ToGetHttpRetryOutputWithContext(ctx context.Context) GetHttpRetryOutput

func (GetHttpRetryOutput) ToGetHttpRetryPtrOutput 

func (o GetHttpRetryOutput) ToGetHttpRetryPtrOutput() GetHttpRetryPtrOutput

func (GetHttpRetryOutput) ToGetHttpRetryPtrOutputWithContext 

func (o GetHttpRetryOutput) ToGetHttpRetryPtrOutputWithContext(ctx context.Context) GetHttpRetryPtrOutput

type GetHttpRetryPtrInput 

type GetHttpRetryPtrInput interface {
	pulumi.Input

	ToGetHttpRetryPtrOutput() GetHttpRetryPtrOutput
	ToGetHttpRetryPtrOutputWithContext(context.Context) GetHttpRetryPtrOutput
}

GetHttpRetryPtrInput is an input type that accepts GetHttpRetryArgs, GetHttpRetryPtr and GetHttpRetryPtrOutput values. You can construct a concrete instance of `GetHttpRetryPtrInput` via: 

        GetHttpRetryArgs{...}

or:

        nil

func GetHttpRetryPtr 

func GetHttpRetryPtr(v *GetHttpRetryArgs) GetHttpRetryPtrInput

type GetHttpRetryPtrOutput 

type GetHttpRetryPtrOutput struct{ *pulumi.OutputState }

func (GetHttpRetryPtrOutput) Attempts 

func (o GetHttpRetryPtrOutput) Attempts() pulumi.IntPtrOutput

The number of times the request is to be retried. For example, if 2 is specified, the request will be tried a maximum of 3 times.

func (GetHttpRetryPtrOutput) Elem 

func (o GetHttpRetryPtrOutput) Elem() GetHttpRetryOutput

func (GetHttpRetryPtrOutput) ElementType 

func (GetHttpRetryPtrOutput) ElementType() reflect.Type

func (GetHttpRetryPtrOutput) MaxDelayMs 

func (o GetHttpRetryPtrOutput) MaxDelayMs() pulumi.IntPtrOutput

The maximum delay between retry requests in milliseconds.

func (GetHttpRetryPtrOutput) MinDelayMs 

func (o GetHttpRetryPtrOutput) MinDelayMs() pulumi.IntPtrOutput

The minimum delay between retry requests in milliseconds.

func (GetHttpRetryPtrOutput) ToGetHttpRetryPtrOutput 

func (o GetHttpRetryPtrOutput) ToGetHttpRetryPtrOutput() GetHttpRetryPtrOutput

func (GetHttpRetryPtrOutput) ToGetHttpRetryPtrOutputWithContext 

func (o GetHttpRetryPtrOutput) ToGetHttpRetryPtrOutputWithContext(ctx context.Context) GetHttpRetryPtrOutput

type Provider 

type Provider struct {
	pulumi.ProviderResourceState
}

The provider type for the http package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs 

type ProviderArgs struct {
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput 

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ElementType 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.