apigateway

package
v1.20.0 Latest Latest
Warning

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

 Go to latest Published: Jan 31, 2020 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Overview

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {
	pulumi.CustomResourceState

	// The ARN of an IAM role for CloudWatch (to allow logging & monitoring).
	// See more [in AWS Docs](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-stage-settings.html#how-to-stage-settings-console).
	// Logging & monitoring can be enabled/disabled and otherwise tuned on the API Gateway Stage level.
	CloudwatchRoleArn pulumi.StringPtrOutput `pulumi:"cloudwatchRoleArn"`
	// Account-Level throttle settings. See exported fields below.
	ThrottleSettings AccountThrottleSettingsOutput `pulumi:"throttleSettings"`
}

Provides a settings of an API Gateway Account. Settings is applied region-wide per `provider` block.

> **Note:** As there is no API method for deleting account settings or resetting it to defaults, destroying this resource will keep your account settings intact

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_account.html.markdown.

func GetAccount 

func GetAccount(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccountState, opts ...pulumi.ResourceOption) (*Account, error)

GetAccount gets an existing Account resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccount 

func NewAccount(ctx *pulumi.Context,
	name string, args *AccountArgs, opts ...pulumi.ResourceOption) (*Account, error)

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

type AccountArgs 

type AccountArgs struct {
	// The ARN of an IAM role for CloudWatch (to allow logging & monitoring).
	// See more [in AWS Docs](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-stage-settings.html#how-to-stage-settings-console).
	// Logging & monitoring can be enabled/disabled and otherwise tuned on the API Gateway Stage level.
	CloudwatchRoleArn pulumi.StringPtrInput
}

The set of arguments for constructing a Account resource.

func (AccountArgs) ElementType added in v1.19.0 

func (AccountArgs) ElementType() reflect.Type

type AccountState 

type AccountState struct {
	// The ARN of an IAM role for CloudWatch (to allow logging & monitoring).
	// See more [in AWS Docs](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-stage-settings.html#how-to-stage-settings-console).
	// Logging & monitoring can be enabled/disabled and otherwise tuned on the API Gateway Stage level.
	CloudwatchRoleArn pulumi.StringPtrInput
	// Account-Level throttle settings. See exported fields below.
	ThrottleSettings AccountThrottleSettingsPtrInput
}

func (AccountState) ElementType added in v1.19.0 

func (AccountState) ElementType() reflect.Type

type AccountThrottleSettings added in v1.19.0 

type AccountThrottleSettings struct {
	// The absolute maximum number of times API Gateway allows the API to be called per second (RPS).
	BurstLimit *int `pulumi:"burstLimit"`
	// The number of times API Gateway allows the API to be called per second on average (RPS).
	RateLimit *float64 `pulumi:"rateLimit"`
}

type AccountThrottleSettingsArgs added in v1.19.0 

type AccountThrottleSettingsArgs struct {
	// The absolute maximum number of times API Gateway allows the API to be called per second (RPS).
	BurstLimit pulumi.IntPtrInput `pulumi:"burstLimit"`
	// The number of times API Gateway allows the API to be called per second on average (RPS).
	RateLimit pulumi.Float64PtrInput `pulumi:"rateLimit"`
}

func (AccountThrottleSettingsArgs) ElementType added in v1.19.0 

func (AccountThrottleSettingsArgs) ElementType() reflect.Type

func (AccountThrottleSettingsArgs) ToAccountThrottleSettingsOutput added in v1.19.0 

func (i AccountThrottleSettingsArgs) ToAccountThrottleSettingsOutput() AccountThrottleSettingsOutput

func (AccountThrottleSettingsArgs) ToAccountThrottleSettingsOutputWithContext added in v1.19.0 

func (i AccountThrottleSettingsArgs) ToAccountThrottleSettingsOutputWithContext(ctx context.Context) AccountThrottleSettingsOutput

func (AccountThrottleSettingsArgs) ToAccountThrottleSettingsPtrOutput added in v1.19.0 

func (i AccountThrottleSettingsArgs) ToAccountThrottleSettingsPtrOutput() AccountThrottleSettingsPtrOutput

func (AccountThrottleSettingsArgs) ToAccountThrottleSettingsPtrOutputWithContext added in v1.19.0 

func (i AccountThrottleSettingsArgs) ToAccountThrottleSettingsPtrOutputWithContext(ctx context.Context) AccountThrottleSettingsPtrOutput

type AccountThrottleSettingsInput added in v1.19.0 

type AccountThrottleSettingsInput interface {
	pulumi.Input

	ToAccountThrottleSettingsOutput() AccountThrottleSettingsOutput
	ToAccountThrottleSettingsOutputWithContext(context.Context) AccountThrottleSettingsOutput
}

type AccountThrottleSettingsOutput added in v1.19.0 

type AccountThrottleSettingsOutput struct{ *pulumi.OutputState }

func (AccountThrottleSettingsOutput) BurstLimit added in v1.19.0 

func (o AccountThrottleSettingsOutput) BurstLimit() pulumi.IntPtrOutput

The absolute maximum number of times API Gateway allows the API to be called per second (RPS).

func (AccountThrottleSettingsOutput) ElementType added in v1.19.0 

func (AccountThrottleSettingsOutput) ElementType() reflect.Type

func (AccountThrottleSettingsOutput) RateLimit added in v1.19.0 

func (o AccountThrottleSettingsOutput) RateLimit() pulumi.Float64PtrOutput

The number of times API Gateway allows the API to be called per second on average (RPS).

func (AccountThrottleSettingsOutput) ToAccountThrottleSettingsOutput added in v1.19.0 

func (o AccountThrottleSettingsOutput) ToAccountThrottleSettingsOutput() AccountThrottleSettingsOutput

func (AccountThrottleSettingsOutput) ToAccountThrottleSettingsOutputWithContext added in v1.19.0 

func (o AccountThrottleSettingsOutput) ToAccountThrottleSettingsOutputWithContext(ctx context.Context) AccountThrottleSettingsOutput

func (AccountThrottleSettingsOutput) ToAccountThrottleSettingsPtrOutput added in v1.19.0 

func (o AccountThrottleSettingsOutput) ToAccountThrottleSettingsPtrOutput() AccountThrottleSettingsPtrOutput

func (AccountThrottleSettingsOutput) ToAccountThrottleSettingsPtrOutputWithContext added in v1.19.0 

func (o AccountThrottleSettingsOutput) ToAccountThrottleSettingsPtrOutputWithContext(ctx context.Context) AccountThrottleSettingsPtrOutput

type AccountThrottleSettingsPtrInput added in v1.19.0 

type AccountThrottleSettingsPtrInput interface {
	pulumi.Input

	ToAccountThrottleSettingsPtrOutput() AccountThrottleSettingsPtrOutput
	ToAccountThrottleSettingsPtrOutputWithContext(context.Context) AccountThrottleSettingsPtrOutput
}

func AccountThrottleSettingsPtr added in v1.19.0 

func AccountThrottleSettingsPtr(v *AccountThrottleSettingsArgs) AccountThrottleSettingsPtrInput

type AccountThrottleSettingsPtrOutput added in v1.19.0 

type AccountThrottleSettingsPtrOutput struct{ *pulumi.OutputState }

func (AccountThrottleSettingsPtrOutput) BurstLimit added in v1.19.0 

func (o AccountThrottleSettingsPtrOutput) BurstLimit() pulumi.IntPtrOutput

The absolute maximum number of times API Gateway allows the API to be called per second (RPS).

func (AccountThrottleSettingsPtrOutput) Elem added in v1.19.0 

func (o AccountThrottleSettingsPtrOutput) Elem() AccountThrottleSettingsOutput

func (AccountThrottleSettingsPtrOutput) ElementType added in v1.19.0 

func (AccountThrottleSettingsPtrOutput) ElementType() reflect.Type

func (AccountThrottleSettingsPtrOutput) RateLimit added in v1.19.0 

func (o AccountThrottleSettingsPtrOutput) RateLimit() pulumi.Float64PtrOutput

The number of times API Gateway allows the API to be called per second on average (RPS).

func (AccountThrottleSettingsPtrOutput) ToAccountThrottleSettingsPtrOutput added in v1.19.0 

func (o AccountThrottleSettingsPtrOutput) ToAccountThrottleSettingsPtrOutput() AccountThrottleSettingsPtrOutput

func (AccountThrottleSettingsPtrOutput) ToAccountThrottleSettingsPtrOutputWithContext added in v1.19.0 

func (o AccountThrottleSettingsPtrOutput) ToAccountThrottleSettingsPtrOutputWithContext(ctx context.Context) AccountThrottleSettingsPtrOutput

type ApiKey 

type ApiKey struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN)
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The creation date of the API key
	CreatedDate pulumi.StringOutput `pulumi:"createdDate"`
	// The API key description. Defaults to "Managed by Pulumi".
	Description pulumi.StringOutput `pulumi:"description"`
	// Specifies whether the API key can be used by callers. Defaults to `true`.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	// The last update date of the API key
	LastUpdatedDate pulumi.StringOutput `pulumi:"lastUpdatedDate"`
	// The name of the API key
	Name pulumi.StringOutput `pulumi:"name"`
	// Key-value mapping of resource tags
	Tags pulumi.MapOutput `pulumi:"tags"`
	// The value of the API key. If not specified, it will be automatically generated by AWS on creation.
	Value pulumi.StringOutput `pulumi:"value"`
}

Provides an API Gateway API Key.

> **NOTE:** Since the API Gateway usage plans feature was launched on August 11, 2016, usage plans are now **required** to associate an API key with an API stage.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_api_key.html.markdown.

func GetApiKey 

func GetApiKey(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApiKeyState, opts ...pulumi.ResourceOption) (*ApiKey, error)

GetApiKey gets an existing ApiKey resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApiKey 

func NewApiKey(ctx *pulumi.Context,
	name string, args *ApiKeyArgs, opts ...pulumi.ResourceOption) (*ApiKey, error)

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

type ApiKeyArgs 

type ApiKeyArgs struct {
	// The API key description. Defaults to "Managed by Pulumi".
	Description pulumi.StringPtrInput
	// Specifies whether the API key can be used by callers. Defaults to `true`.
	Enabled pulumi.BoolPtrInput
	// The name of the API key
	Name pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
	// The value of the API key. If not specified, it will be automatically generated by AWS on creation.
	Value pulumi.StringPtrInput
}

The set of arguments for constructing a ApiKey resource.

func (ApiKeyArgs) ElementType added in v1.19.0 

func (ApiKeyArgs) ElementType() reflect.Type

type ApiKeyState 

type ApiKeyState struct {
	// Amazon Resource Name (ARN)
	Arn pulumi.StringPtrInput
	// The creation date of the API key
	CreatedDate pulumi.StringPtrInput
	// The API key description. Defaults to "Managed by Pulumi".
	Description pulumi.StringPtrInput
	// Specifies whether the API key can be used by callers. Defaults to `true`.
	Enabled pulumi.BoolPtrInput
	// The last update date of the API key
	LastUpdatedDate pulumi.StringPtrInput
	// The name of the API key
	Name pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
	// The value of the API key. If not specified, it will be automatically generated by AWS on creation.
	Value pulumi.StringPtrInput
}

func (ApiKeyState) ElementType added in v1.19.0 

func (ApiKeyState) ElementType() reflect.Type

type Authorizer 

type Authorizer struct {
	pulumi.CustomResourceState

	// The credentials required for the authorizer.
	// To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.
	AuthorizerCredentials pulumi.StringPtrOutput `pulumi:"authorizerCredentials"`
	// The TTL of cached authorizer results in seconds.
	// Defaults to `300`.
	AuthorizerResultTtlInSeconds pulumi.IntPtrOutput `pulumi:"authorizerResultTtlInSeconds"`
	// The authorizer's Uniform Resource Identifier (URI).
	// This must be a well-formed Lambda function URI in the form of `arn:aws:apigateway:{region}:lambda:path/{service_api}`,
	// e.g. `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations`
	AuthorizerUri pulumi.StringPtrOutput `pulumi:"authorizerUri"`
	// The source of the identity in an incoming request.
	// Defaults to `method.request.header.Authorization`. For `REQUEST` type, this may be a comma-separated list of values, including headers, query string parameters and stage variables - e.g. `"method.request.header.SomeHeaderName,method.request.querystring.SomeQueryStringName,stageVariables.SomeStageVariableName"`
	IdentitySource pulumi.StringPtrOutput `pulumi:"identitySource"`
	// A validation expression for the incoming identity.
	// For `TOKEN` type, this value should be a regular expression. The incoming token from the client is matched
	// against this expression, and will proceed if the token matches. If the token doesn't match,
	// the client receives a 401 Unauthorized response.
	IdentityValidationExpression pulumi.StringPtrOutput `pulumi:"identityValidationExpression"`
	// The name of the authorizer
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of the Amazon Cognito user pool ARNs.
	// Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`.
	ProviderArns pulumi.StringArrayOutput `pulumi:"providerArns"`
	// The ID of the associated REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// The type of the authorizer. Possible values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, or `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.
	// Defaults to `TOKEN`.
	Type pulumi.StringPtrOutput `pulumi:"type"`
}

Provides an API Gateway Authorizer.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_authorizer.html.markdown.

func GetAuthorizer 

func GetAuthorizer(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AuthorizerState, opts ...pulumi.ResourceOption) (*Authorizer, error)

GetAuthorizer gets an existing Authorizer resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAuthorizer 

func NewAuthorizer(ctx *pulumi.Context,
	name string, args *AuthorizerArgs, opts ...pulumi.ResourceOption) (*Authorizer, error)

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

type AuthorizerArgs 

type AuthorizerArgs struct {
	// The credentials required for the authorizer.
	// To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.
	AuthorizerCredentials pulumi.StringPtrInput
	// The TTL of cached authorizer results in seconds.
	// Defaults to `300`.
	AuthorizerResultTtlInSeconds pulumi.IntPtrInput
	// The authorizer's Uniform Resource Identifier (URI).
	// This must be a well-formed Lambda function URI in the form of `arn:aws:apigateway:{region}:lambda:path/{service_api}`,
	// e.g. `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations`
	AuthorizerUri pulumi.StringPtrInput
	// The source of the identity in an incoming request.
	// Defaults to `method.request.header.Authorization`. For `REQUEST` type, this may be a comma-separated list of values, including headers, query string parameters and stage variables - e.g. `"method.request.header.SomeHeaderName,method.request.querystring.SomeQueryStringName,stageVariables.SomeStageVariableName"`
	IdentitySource pulumi.StringPtrInput
	// A validation expression for the incoming identity.
	// For `TOKEN` type, this value should be a regular expression. The incoming token from the client is matched
	// against this expression, and will proceed if the token matches. If the token doesn't match,
	// the client receives a 401 Unauthorized response.
	IdentityValidationExpression pulumi.StringPtrInput
	// The name of the authorizer
	Name pulumi.StringPtrInput
	// A list of the Amazon Cognito user pool ARNs.
	// Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`.
	ProviderArns pulumi.StringArrayInput
	// The ID of the associated REST API
	RestApi pulumi.StringInput
	// The type of the authorizer. Possible values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, or `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.
	// Defaults to `TOKEN`.
	Type pulumi.StringPtrInput
}

The set of arguments for constructing a Authorizer resource.

func (AuthorizerArgs) ElementType added in v1.19.0 

func (AuthorizerArgs) ElementType() reflect.Type

type AuthorizerState 

type AuthorizerState struct {
	// The credentials required for the authorizer.
	// To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.
	AuthorizerCredentials pulumi.StringPtrInput
	// The TTL of cached authorizer results in seconds.
	// Defaults to `300`.
	AuthorizerResultTtlInSeconds pulumi.IntPtrInput
	// The authorizer's Uniform Resource Identifier (URI).
	// This must be a well-formed Lambda function URI in the form of `arn:aws:apigateway:{region}:lambda:path/{service_api}`,
	// e.g. `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations`
	AuthorizerUri pulumi.StringPtrInput
	// The source of the identity in an incoming request.
	// Defaults to `method.request.header.Authorization`. For `REQUEST` type, this may be a comma-separated list of values, including headers, query string parameters and stage variables - e.g. `"method.request.header.SomeHeaderName,method.request.querystring.SomeQueryStringName,stageVariables.SomeStageVariableName"`
	IdentitySource pulumi.StringPtrInput
	// A validation expression for the incoming identity.
	// For `TOKEN` type, this value should be a regular expression. The incoming token from the client is matched
	// against this expression, and will proceed if the token matches. If the token doesn't match,
	// the client receives a 401 Unauthorized response.
	IdentityValidationExpression pulumi.StringPtrInput
	// The name of the authorizer
	Name pulumi.StringPtrInput
	// A list of the Amazon Cognito user pool ARNs.
	// Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`.
	ProviderArns pulumi.StringArrayInput
	// The ID of the associated REST API
	RestApi pulumi.StringPtrInput
	// The type of the authorizer. Possible values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, or `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.
	// Defaults to `TOKEN`.
	Type pulumi.StringPtrInput
}

func (AuthorizerState) ElementType added in v1.19.0 

func (AuthorizerState) ElementType() reflect.Type

type BasePathMapping 

type BasePathMapping struct {
	pulumi.CustomResourceState

	// Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
	BasePath pulumi.StringPtrOutput `pulumi:"basePath"`
	// The already-registered domain name to connect the API to.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// The id of the API to connect.
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// The name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.
	StageName pulumi.StringPtrOutput `pulumi:"stageName"`
}

Connects a custom domain name registered via `apigateway.DomainName` with a deployed API so that its methods can be called via the custom domain name.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_base_path_mapping.html.markdown.

func GetBasePathMapping 

func GetBasePathMapping(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BasePathMappingState, opts ...pulumi.ResourceOption) (*BasePathMapping, error)

GetBasePathMapping gets an existing BasePathMapping resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewBasePathMapping 

func NewBasePathMapping(ctx *pulumi.Context,
	name string, args *BasePathMappingArgs, opts ...pulumi.ResourceOption) (*BasePathMapping, error)

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

type BasePathMappingArgs 

type BasePathMappingArgs struct {
	// Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
	BasePath pulumi.StringPtrInput
	// The already-registered domain name to connect the API to.
	DomainName pulumi.StringInput
	// The id of the API to connect.
	RestApi pulumi.StringInput
	// The name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.
	StageName pulumi.StringPtrInput
}

The set of arguments for constructing a BasePathMapping resource.

func (BasePathMappingArgs) ElementType added in v1.19.0 

func (BasePathMappingArgs) ElementType() reflect.Type

type BasePathMappingState 

type BasePathMappingState struct {
	// Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
	BasePath pulumi.StringPtrInput
	// The already-registered domain name to connect the API to.
	DomainName pulumi.StringPtrInput
	// The id of the API to connect.
	RestApi pulumi.StringPtrInput
	// The name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.
	StageName pulumi.StringPtrInput
}

func (BasePathMappingState) ElementType added in v1.19.0 

func (BasePathMappingState) ElementType() reflect.Type

type ClientCertificate 

type ClientCertificate struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN)
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The date when the client certificate was created.
	CreatedDate pulumi.StringOutput `pulumi:"createdDate"`
	// The description of the client certificate.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The date when the client certificate will expire.
	ExpirationDate pulumi.StringOutput `pulumi:"expirationDate"`
	// The PEM-encoded public key of the client certificate.
	PemEncodedCertificate pulumi.StringOutput `pulumi:"pemEncodedCertificate"`
	// Key-value mapping of resource tags
	Tags pulumi.MapOutput `pulumi:"tags"`
}

Provides an API Gateway Client Certificate.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_client_certificate.html.markdown.

func GetClientCertificate 

func GetClientCertificate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ClientCertificateState, opts ...pulumi.ResourceOption) (*ClientCertificate, error)

GetClientCertificate gets an existing ClientCertificate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClientCertificate 

func NewClientCertificate(ctx *pulumi.Context,
	name string, args *ClientCertificateArgs, opts ...pulumi.ResourceOption) (*ClientCertificate, error)

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

type ClientCertificateArgs 

type ClientCertificateArgs struct {
	// The description of the client certificate.
	Description pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
}

The set of arguments for constructing a ClientCertificate resource.

func (ClientCertificateArgs) ElementType added in v1.19.0 

func (ClientCertificateArgs) ElementType() reflect.Type

type ClientCertificateState 

type ClientCertificateState struct {
	// Amazon Resource Name (ARN)
	Arn pulumi.StringPtrInput
	// The date when the client certificate was created.
	CreatedDate pulumi.StringPtrInput
	// The description of the client certificate.
	Description pulumi.StringPtrInput
	// The date when the client certificate will expire.
	ExpirationDate pulumi.StringPtrInput
	// The PEM-encoded public key of the client certificate.
	PemEncodedCertificate pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
}

func (ClientCertificateState) ElementType added in v1.19.0 

func (ClientCertificateState) ElementType() reflect.Type

type Deployment 

type Deployment struct {
	pulumi.CustomResourceState

	// The creation date of the deployment
	CreatedDate pulumi.StringOutput `pulumi:"createdDate"`
	// The description of the deployment
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The execution ARN to be used in [`lambdaPermission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn`
	// when allowing API Gateway to invoke a Lambda function,
	// e.g. `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod`
	ExecutionArn pulumi.StringOutput `pulumi:"executionArn"`
	// The URL to invoke the API pointing to the stage,
	// e.g. `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod`
	InvokeUrl pulumi.StringOutput `pulumi:"invokeUrl"`
	// The ID of the associated REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// The description of the stage
	StageDescription pulumi.StringPtrOutput `pulumi:"stageDescription"`
	// The name of the stage. If the specified stage already exists, it will be updated to point to the new deployment. If the stage does not exist, a new one will be created and point to this deployment.
	StageName pulumi.StringPtrOutput `pulumi:"stageName"`
	// A map that defines variables for the stage
	Variables pulumi.StringMapOutput `pulumi:"variables"`
}

Provides an API Gateway Deployment.

> **Note:** Depends on having `apigateway.Integration` inside your rest api (which in turn depends on `apigateway.Method`). To avoid race conditions you might need to add an explicit `dependsOn = ["aws_api_gateway_integration.name"]`.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_deployment.html.markdown.

func GetDeployment 

func GetDeployment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DeploymentState, opts ...pulumi.ResourceOption) (*Deployment, error)

GetDeployment gets an existing Deployment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDeployment 

func NewDeployment(ctx *pulumi.Context,
	name string, args *DeploymentArgs, opts ...pulumi.ResourceOption) (*Deployment, error)

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

type DeploymentArgs 

type DeploymentArgs struct {
	// The description of the deployment
	Description pulumi.StringPtrInput
	// The ID of the associated REST API
	RestApi pulumi.StringInput
	// The description of the stage
	StageDescription pulumi.StringPtrInput
	// The name of the stage. If the specified stage already exists, it will be updated to point to the new deployment. If the stage does not exist, a new one will be created and point to this deployment.
	StageName pulumi.StringPtrInput
	// A map that defines variables for the stage
	Variables pulumi.StringMapInput
}

The set of arguments for constructing a Deployment resource.

func (DeploymentArgs) ElementType added in v1.19.0 

func (DeploymentArgs) ElementType() reflect.Type

type DeploymentState 

type DeploymentState struct {
	// The creation date of the deployment
	CreatedDate pulumi.StringPtrInput
	// The description of the deployment
	Description pulumi.StringPtrInput
	// The execution ARN to be used in [`lambdaPermission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn`
	// when allowing API Gateway to invoke a Lambda function,
	// e.g. `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod`
	ExecutionArn pulumi.StringPtrInput
	// The URL to invoke the API pointing to the stage,
	// e.g. `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod`
	InvokeUrl pulumi.StringPtrInput
	// The ID of the associated REST API
	RestApi pulumi.StringPtrInput
	// The description of the stage
	StageDescription pulumi.StringPtrInput
	// The name of the stage. If the specified stage already exists, it will be updated to point to the new deployment. If the stage does not exist, a new one will be created and point to this deployment.
	StageName pulumi.StringPtrInput
	// A map that defines variables for the stage
	Variables pulumi.StringMapInput
}

func (DeploymentState) ElementType added in v1.19.0 

func (DeploymentState) ElementType() reflect.Type

type DocumentationPart 

type DocumentationPart struct {
	pulumi.CustomResourceState

	// The location of the targeted API entity of the to-be-created documentation part. See below.
	Location DocumentationPartLocationOutput `pulumi:"location"`
	// A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant key-value pairs can be exported and, hence, published.
	Properties pulumi.StringOutput `pulumi:"properties"`
	// The ID of the associated Rest API
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
}

Provides a settings of an API Gateway Documentation Part.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_documentation_part.html.markdown.

func GetDocumentationPart 

func GetDocumentationPart(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DocumentationPartState, opts ...pulumi.ResourceOption) (*DocumentationPart, error)

GetDocumentationPart gets an existing DocumentationPart resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDocumentationPart 

func NewDocumentationPart(ctx *pulumi.Context,
	name string, args *DocumentationPartArgs, opts ...pulumi.ResourceOption) (*DocumentationPart, error)

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

type DocumentationPartArgs 

type DocumentationPartArgs struct {
	// The location of the targeted API entity of the to-be-created documentation part. See below.
	Location DocumentationPartLocationInput
	// A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant key-value pairs can be exported and, hence, published.
	Properties pulumi.StringInput
	// The ID of the associated Rest API
	RestApiId pulumi.StringInput
}

The set of arguments for constructing a DocumentationPart resource.

func (DocumentationPartArgs) ElementType added in v1.19.0 

func (DocumentationPartArgs) ElementType() reflect.Type

type DocumentationPartLocation added in v1.19.0 

type DocumentationPartLocation struct {
	// The HTTP verb of a method. The default value is `*` for any method.
	Method *string `pulumi:"method"`
	// The name of the targeted API entity.
	Name *string `pulumi:"name"`
	// The URL path of the target. The default value is `/` for the root resource.
	Path *string `pulumi:"path"`
	// The HTTP status code of a response. The default value is `*` for any status code.
	StatusCode *string `pulumi:"statusCode"`
	// The type of API entity to which the documentation content applies. e.g. `API`, `METHOD` or `REQUEST_BODY`
	Type string `pulumi:"type"`
}

type DocumentationPartLocationArgs added in v1.19.0 

type DocumentationPartLocationArgs struct {
	// The HTTP verb of a method. The default value is `*` for any method.
	Method pulumi.StringPtrInput `pulumi:"method"`
	// The name of the targeted API entity.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The URL path of the target. The default value is `/` for the root resource.
	Path pulumi.StringPtrInput `pulumi:"path"`
	// The HTTP status code of a response. The default value is `*` for any status code.
	StatusCode pulumi.StringPtrInput `pulumi:"statusCode"`
	// The type of API entity to which the documentation content applies. e.g. `API`, `METHOD` or `REQUEST_BODY`
	Type pulumi.StringInput `pulumi:"type"`
}

func (DocumentationPartLocationArgs) ElementType added in v1.19.0 

func (DocumentationPartLocationArgs) ElementType() reflect.Type

func (DocumentationPartLocationArgs) ToDocumentationPartLocationOutput added in v1.19.0 

func (i DocumentationPartLocationArgs) ToDocumentationPartLocationOutput() DocumentationPartLocationOutput

func (DocumentationPartLocationArgs) ToDocumentationPartLocationOutputWithContext added in v1.19.0 

func (i DocumentationPartLocationArgs) ToDocumentationPartLocationOutputWithContext(ctx context.Context) DocumentationPartLocationOutput

func (DocumentationPartLocationArgs) ToDocumentationPartLocationPtrOutput added in v1.19.0 

func (i DocumentationPartLocationArgs) ToDocumentationPartLocationPtrOutput() DocumentationPartLocationPtrOutput

func (DocumentationPartLocationArgs) ToDocumentationPartLocationPtrOutputWithContext added in v1.19.0 

func (i DocumentationPartLocationArgs) ToDocumentationPartLocationPtrOutputWithContext(ctx context.Context) DocumentationPartLocationPtrOutput

type DocumentationPartLocationInput added in v1.19.0 

type DocumentationPartLocationInput interface {
	pulumi.Input

	ToDocumentationPartLocationOutput() DocumentationPartLocationOutput
	ToDocumentationPartLocationOutputWithContext(context.Context) DocumentationPartLocationOutput
}

type DocumentationPartLocationOutput added in v1.19.0 

type DocumentationPartLocationOutput struct{ *pulumi.OutputState }

func (DocumentationPartLocationOutput) ElementType added in v1.19.0 

func (DocumentationPartLocationOutput) ElementType() reflect.Type

func (DocumentationPartLocationOutput) Method added in v1.19.0 

func (o DocumentationPartLocationOutput) Method() pulumi.StringPtrOutput

The HTTP verb of a method. The default value is `*` for any method.

func (DocumentationPartLocationOutput) Name added in v1.19.0 

func (o DocumentationPartLocationOutput) Name() pulumi.StringPtrOutput

The name of the targeted API entity.

func (DocumentationPartLocationOutput) Path added in v1.19.0 

func (o DocumentationPartLocationOutput) Path() pulumi.StringPtrOutput

The URL path of the target. The default value is `/` for the root resource.

func (DocumentationPartLocationOutput) StatusCode added in v1.19.0 

func (o DocumentationPartLocationOutput) StatusCode() pulumi.StringPtrOutput

The HTTP status code of a response. The default value is `*` for any status code.

func (DocumentationPartLocationOutput) ToDocumentationPartLocationOutput added in v1.19.0 

func (o DocumentationPartLocationOutput) ToDocumentationPartLocationOutput() DocumentationPartLocationOutput

func (DocumentationPartLocationOutput) ToDocumentationPartLocationOutputWithContext added in v1.19.0 

func (o DocumentationPartLocationOutput) ToDocumentationPartLocationOutputWithContext(ctx context.Context) DocumentationPartLocationOutput

func (DocumentationPartLocationOutput) ToDocumentationPartLocationPtrOutput added in v1.19.0 

func (o DocumentationPartLocationOutput) ToDocumentationPartLocationPtrOutput() DocumentationPartLocationPtrOutput

func (DocumentationPartLocationOutput) ToDocumentationPartLocationPtrOutputWithContext added in v1.19.0 

func (o DocumentationPartLocationOutput) ToDocumentationPartLocationPtrOutputWithContext(ctx context.Context) DocumentationPartLocationPtrOutput

func (DocumentationPartLocationOutput) Type added in v1.19.0 

func (o DocumentationPartLocationOutput) Type() pulumi.StringOutput

The type of API entity to which the documentation content applies. e.g. `API`, `METHOD` or `REQUEST_BODY`

type DocumentationPartLocationPtrInput added in v1.19.0 

type DocumentationPartLocationPtrInput interface {
	pulumi.Input

	ToDocumentationPartLocationPtrOutput() DocumentationPartLocationPtrOutput
	ToDocumentationPartLocationPtrOutputWithContext(context.Context) DocumentationPartLocationPtrOutput
}

func DocumentationPartLocationPtr added in v1.19.0 

func DocumentationPartLocationPtr(v *DocumentationPartLocationArgs) DocumentationPartLocationPtrInput

type DocumentationPartLocationPtrOutput added in v1.19.0 

type DocumentationPartLocationPtrOutput struct{ *pulumi.OutputState }

func (DocumentationPartLocationPtrOutput) Elem added in v1.19.0 

func (o DocumentationPartLocationPtrOutput) Elem() DocumentationPartLocationOutput

func (DocumentationPartLocationPtrOutput) ElementType added in v1.19.0 

func (DocumentationPartLocationPtrOutput) ElementType() reflect.Type

func (DocumentationPartLocationPtrOutput) Method added in v1.19.0 

func (o DocumentationPartLocationPtrOutput) Method() pulumi.StringPtrOutput

The HTTP verb of a method. The default value is `*` for any method.

func (DocumentationPartLocationPtrOutput) Name added in v1.19.0 

func (o DocumentationPartLocationPtrOutput) Name() pulumi.StringPtrOutput

The name of the targeted API entity.

func (DocumentationPartLocationPtrOutput) Path added in v1.19.0 

func (o DocumentationPartLocationPtrOutput) Path() pulumi.StringPtrOutput

The URL path of the target. The default value is `/` for the root resource.

func (DocumentationPartLocationPtrOutput) StatusCode added in v1.19.0 

func (o DocumentationPartLocationPtrOutput) StatusCode() pulumi.StringPtrOutput

The HTTP status code of a response. The default value is `*` for any status code.

func (DocumentationPartLocationPtrOutput) ToDocumentationPartLocationPtrOutput added in v1.19.0 

func (o DocumentationPartLocationPtrOutput) ToDocumentationPartLocationPtrOutput() DocumentationPartLocationPtrOutput

func (DocumentationPartLocationPtrOutput) ToDocumentationPartLocationPtrOutputWithContext added in v1.19.0 

func (o DocumentationPartLocationPtrOutput) ToDocumentationPartLocationPtrOutputWithContext(ctx context.Context) DocumentationPartLocationPtrOutput

func (DocumentationPartLocationPtrOutput) Type added in v1.19.0 

func (o DocumentationPartLocationPtrOutput) Type() pulumi.StringOutput

The type of API entity to which the documentation content applies. e.g. `API`, `METHOD` or `REQUEST_BODY`

type DocumentationPartState 

type DocumentationPartState struct {
	// The location of the targeted API entity of the to-be-created documentation part. See below.
	Location DocumentationPartLocationPtrInput
	// A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant key-value pairs can be exported and, hence, published.
	Properties pulumi.StringPtrInput
	// The ID of the associated Rest API
	RestApiId pulumi.StringPtrInput
}

func (DocumentationPartState) ElementType added in v1.19.0 

func (DocumentationPartState) ElementType() reflect.Type

type DocumentationVersion 

type DocumentationVersion struct {
	pulumi.CustomResourceState

	// The description of the API documentation version.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The ID of the associated Rest API
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// The version identifier of the API documentation snapshot.
	Version pulumi.StringOutput `pulumi:"version"`
}

Provides a resource to manage an API Gateway Documentation Version.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_documentation_version.html.markdown.

func GetDocumentationVersion 

func GetDocumentationVersion(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DocumentationVersionState, opts ...pulumi.ResourceOption) (*DocumentationVersion, error)

GetDocumentationVersion gets an existing DocumentationVersion resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDocumentationVersion 

func NewDocumentationVersion(ctx *pulumi.Context,
	name string, args *DocumentationVersionArgs, opts ...pulumi.ResourceOption) (*DocumentationVersion, error)

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

type DocumentationVersionArgs 

type DocumentationVersionArgs struct {
	// The description of the API documentation version.
	Description pulumi.StringPtrInput
	// The ID of the associated Rest API
	RestApiId pulumi.StringInput
	// The version identifier of the API documentation snapshot.
	Version pulumi.StringInput
}

The set of arguments for constructing a DocumentationVersion resource.

func (DocumentationVersionArgs) ElementType added in v1.19.0 

func (DocumentationVersionArgs) ElementType() reflect.Type

type DocumentationVersionState 

type DocumentationVersionState struct {
	// The description of the API documentation version.
	Description pulumi.StringPtrInput
	// The ID of the associated Rest API
	RestApiId pulumi.StringPtrInput
	// The version identifier of the API documentation snapshot.
	Version pulumi.StringPtrInput
}

func (DocumentationVersionState) ElementType added in v1.19.0 

func (DocumentationVersionState) ElementType() reflect.Type

type DomainName 

type DomainName struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN)
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when an edge-optimized domain name is desired. Conflicts with `certificateName`, `certificateBody`, `certificateChain`, `certificatePrivateKey`, `regionalCertificateArn`, and `regionalCertificateName`.
	CertificateArn pulumi.StringPtrOutput `pulumi:"certificateArn"`
	// The certificate issued for the domain name
	// being registered, in PEM format. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`, `regionalCertificateArn`, and
	// `regionalCertificateName`.
	CertificateBody pulumi.StringPtrOutput `pulumi:"certificateBody"`
	// The certificate for the CA that issued the
	// certificate, along with any intermediate CA certificates required to
	// create an unbroken chain to a certificate trusted by the intended API clients. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`,
	// `regionalCertificateArn`, and `regionalCertificateName`.
	CertificateChain pulumi.StringPtrOutput `pulumi:"certificateChain"`
	// The unique name to use when registering this
	// certificate as an IAM server certificate. Conflicts with `certificateArn`, `regionalCertificateArn`, and
	// `regionalCertificateName`. Required if `certificateArn` is not set.
	CertificateName pulumi.StringPtrOutput `pulumi:"certificateName"`
	// The private key associated with the
	// domain certificate given in `certificateBody`. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`, `regionalCertificateArn`, and `regionalCertificateName`.
	CertificatePrivateKey pulumi.StringPtrOutput `pulumi:"certificatePrivateKey"`
	// The upload date associated with the domain certificate.
	CertificateUploadDate pulumi.StringOutput `pulumi:"certificateUploadDate"`
	// The hostname created by Cloudfront to represent
	// the distribution that implements this domain name mapping.
	CloudfrontDomainName pulumi.StringOutput `pulumi:"cloudfrontDomainName"`
	// For convenience, the hosted zone ID (`Z2FDTNDATAQYW2`)
	// that can be used to create a Route53 alias record for the distribution.
	CloudfrontZoneId pulumi.StringOutput `pulumi:"cloudfrontZoneId"`
	// The fully-qualified domain name to register
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// Configuration block defining API endpoint information including type. Defined below.
	EndpointConfiguration DomainNameEndpointConfigurationOutput `pulumi:"endpointConfiguration"`
	// The ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when a regional domain name is desired. Conflicts with `certificateArn`, `certificateName`, `certificateBody`, `certificateChain`, and `certificatePrivateKey`.
	RegionalCertificateArn pulumi.StringPtrOutput `pulumi:"regionalCertificateArn"`
	// The user-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts with `certificateArn`, `certificateName`, `certificateBody`, `certificateChain`, and
	// `certificatePrivateKey`.
	RegionalCertificateName pulumi.StringPtrOutput `pulumi:"regionalCertificateName"`
	// The hostname for the custom domain's regional endpoint.
	RegionalDomainName pulumi.StringOutput `pulumi:"regionalDomainName"`
	// The hosted zone ID that can be used to create a Route53 alias record for the regional endpoint.
	RegionalZoneId pulumi.StringOutput `pulumi:"regionalZoneId"`
	// The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are `TLS_1_0` and `TLS_1_2`. Must be configured to perform drift detection.
	SecurityPolicy pulumi.StringOutput `pulumi:"securityPolicy"`
	// Key-value mapping of resource tags
	Tags pulumi.MapOutput `pulumi:"tags"`
}

Registers a custom domain name for use with AWS API Gateway. Additional information about this functionality can be found in the [API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html).

This resource just establishes ownership of and the TLS settings for a particular domain name. An API can be attached to a particular path under the registered domain name using the `apigateway.BasePathMapping` resource.

API Gateway domains can be defined as either 'edge-optimized' or 'regional'. In an edge-optimized configuration, API Gateway internally creates and manages a CloudFront distribution to route requests on the given hostname. In addition to this resource it's necessary to create a DNS record corresponding to the given domain name which is an alias (either Route53 alias or traditional CNAME) to the Cloudfront domain name exported in the `cloudfrontDomainName` attribute.

In a regional configuration, API Gateway does not create a CloudFront distribution to route requests to the API, though a distribution can be created if needed. In either case, it is necessary to create a DNS record corresponding to the given domain name which is an alias (either Route53 alias or traditional CNAME) to the regional domain name exported in the `regionalDomainName` attribute.

> **Note:** API Gateway requires the use of AWS Certificate Manager (ACM) certificates instead of Identity and Access Management (IAM) certificates in regions that support ACM. Regions that support ACM can be found in the [Regions and Endpoints Documentation](https://docs.aws.amazon.com/general/latest/gr/rande.html#acm_region). To import an existing private key and certificate into ACM or request an ACM certificate, see the [`acm.Certificate` resource](https://www.terraform.io/docs/providers/aws/r/acm_certificate.html).

> **Note:** The `apigateway.DomainName` resource expects dependency on the `acm.CertificateValidation` as only verified certificates can be used. This can be made either explicitly by adding the `dependsOn = [aws_acm_certificate_validation.cert]` attribute. Or implicitly by referring certificate ARN from the validation resource where it will be available after the resource creation: `regionalCertificateArn = aws_acm_certificate_validation.cert.certificate_arn`.

> **Note:** All arguments including the private key will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html).

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_domain_name.html.markdown.

func GetDomainName 

func GetDomainName(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DomainNameState, opts ...pulumi.ResourceOption) (*DomainName, error)

GetDomainName gets an existing DomainName resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDomainName 

func NewDomainName(ctx *pulumi.Context,
	name string, args *DomainNameArgs, opts ...pulumi.ResourceOption) (*DomainName, error)

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

type DomainNameArgs 

type DomainNameArgs struct {
	// The ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when an edge-optimized domain name is desired. Conflicts with `certificateName`, `certificateBody`, `certificateChain`, `certificatePrivateKey`, `regionalCertificateArn`, and `regionalCertificateName`.
	CertificateArn pulumi.StringPtrInput
	// The certificate issued for the domain name
	// being registered, in PEM format. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`, `regionalCertificateArn`, and
	// `regionalCertificateName`.
	CertificateBody pulumi.StringPtrInput
	// The certificate for the CA that issued the
	// certificate, along with any intermediate CA certificates required to
	// create an unbroken chain to a certificate trusted by the intended API clients. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`,
	// `regionalCertificateArn`, and `regionalCertificateName`.
	CertificateChain pulumi.StringPtrInput
	// The unique name to use when registering this
	// certificate as an IAM server certificate. Conflicts with `certificateArn`, `regionalCertificateArn`, and
	// `regionalCertificateName`. Required if `certificateArn` is not set.
	CertificateName pulumi.StringPtrInput
	// The private key associated with the
	// domain certificate given in `certificateBody`. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`, `regionalCertificateArn`, and `regionalCertificateName`.
	CertificatePrivateKey pulumi.StringPtrInput
	// The fully-qualified domain name to register
	DomainName pulumi.StringInput
	// Configuration block defining API endpoint information including type. Defined below.
	EndpointConfiguration DomainNameEndpointConfigurationPtrInput
	// The ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when a regional domain name is desired. Conflicts with `certificateArn`, `certificateName`, `certificateBody`, `certificateChain`, and `certificatePrivateKey`.
	RegionalCertificateArn pulumi.StringPtrInput
	// The user-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts with `certificateArn`, `certificateName`, `certificateBody`, `certificateChain`, and
	// `certificatePrivateKey`.
	RegionalCertificateName pulumi.StringPtrInput
	// The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are `TLS_1_0` and `TLS_1_2`. Must be configured to perform drift detection.
	SecurityPolicy pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
}

The set of arguments for constructing a DomainName resource.

func (DomainNameArgs) ElementType added in v1.19.0 

func (DomainNameArgs) ElementType() reflect.Type

type DomainNameEndpointConfiguration added in v1.19.0 

type DomainNameEndpointConfiguration struct {
	// A list of endpoint types. This resource currently only supports managing a single value. Valid values: `EDGE` or `REGIONAL`. If unspecified, defaults to `EDGE`. Must be declared as `REGIONAL` in non-Commercial partitions. Refer to the [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-regional-api.html) for more information on the difference between edge-optimized and regional APIs.
	Types string `pulumi:"types"`
}

type DomainNameEndpointConfigurationArgs added in v1.19.0 

type DomainNameEndpointConfigurationArgs struct {
	// A list of endpoint types. This resource currently only supports managing a single value. Valid values: `EDGE` or `REGIONAL`. If unspecified, defaults to `EDGE`. Must be declared as `REGIONAL` in non-Commercial partitions. Refer to the [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-regional-api.html) for more information on the difference between edge-optimized and regional APIs.
	Types pulumi.StringInput `pulumi:"types"`
}

func (DomainNameEndpointConfigurationArgs) ElementType added in v1.19.0 

func (DomainNameEndpointConfigurationArgs) ElementType() reflect.Type

func (DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationOutput added in v1.19.0 

func (i DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationOutput() DomainNameEndpointConfigurationOutput

func (DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationOutputWithContext added in v1.19.0 

func (i DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationOutputWithContext(ctx context.Context) DomainNameEndpointConfigurationOutput

func (DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationPtrOutput added in v1.19.0 

func (i DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationPtrOutput() DomainNameEndpointConfigurationPtrOutput

func (DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationPtrOutputWithContext added in v1.19.0 

func (i DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationPtrOutputWithContext(ctx context.Context) DomainNameEndpointConfigurationPtrOutput

type DomainNameEndpointConfigurationInput added in v1.19.0 

type DomainNameEndpointConfigurationInput interface {
	pulumi.Input

	ToDomainNameEndpointConfigurationOutput() DomainNameEndpointConfigurationOutput
	ToDomainNameEndpointConfigurationOutputWithContext(context.Context) DomainNameEndpointConfigurationOutput
}

type DomainNameEndpointConfigurationOutput added in v1.19.0 

type DomainNameEndpointConfigurationOutput struct{ *pulumi.OutputState }

func (DomainNameEndpointConfigurationOutput) ElementType added in v1.19.0 

func (DomainNameEndpointConfigurationOutput) ElementType() reflect.Type

func (DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationOutput added in v1.19.0 

func (o DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationOutput() DomainNameEndpointConfigurationOutput

func (DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationOutputWithContext added in v1.19.0 

func (o DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationOutputWithContext(ctx context.Context) DomainNameEndpointConfigurationOutput

func (DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationPtrOutput added in v1.19.0 

func (o DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationPtrOutput() DomainNameEndpointConfigurationPtrOutput

func (DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationPtrOutputWithContext added in v1.19.0 

func (o DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationPtrOutputWithContext(ctx context.Context) DomainNameEndpointConfigurationPtrOutput

func (DomainNameEndpointConfigurationOutput) Types added in v1.19.0 

func (o DomainNameEndpointConfigurationOutput) Types() pulumi.StringOutput

A list of endpoint types. This resource currently only supports managing a single value. Valid values: `EDGE` or `REGIONAL`. If unspecified, defaults to `EDGE`. Must be declared as `REGIONAL` in non-Commercial partitions. Refer to the [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-regional-api.html) for more information on the difference between edge-optimized and regional APIs.

type DomainNameEndpointConfigurationPtrInput added in v1.19.0 

type DomainNameEndpointConfigurationPtrInput interface {
	pulumi.Input

	ToDomainNameEndpointConfigurationPtrOutput() DomainNameEndpointConfigurationPtrOutput
	ToDomainNameEndpointConfigurationPtrOutputWithContext(context.Context) DomainNameEndpointConfigurationPtrOutput
}

func DomainNameEndpointConfigurationPtr added in v1.19.0 

func DomainNameEndpointConfigurationPtr(v *DomainNameEndpointConfigurationArgs) DomainNameEndpointConfigurationPtrInput

type DomainNameEndpointConfigurationPtrOutput added in v1.19.0 

type DomainNameEndpointConfigurationPtrOutput struct{ *pulumi.OutputState }

func (DomainNameEndpointConfigurationPtrOutput) Elem added in v1.19.0 

func (o DomainNameEndpointConfigurationPtrOutput) Elem() DomainNameEndpointConfigurationOutput

func (DomainNameEndpointConfigurationPtrOutput) ElementType added in v1.19.0 

func (DomainNameEndpointConfigurationPtrOutput) ElementType() reflect.Type

func (DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutput added in v1.19.0 

func (o DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutput() DomainNameEndpointConfigurationPtrOutput

func (DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutputWithContext added in v1.19.0 

func (o DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutputWithContext(ctx context.Context) DomainNameEndpointConfigurationPtrOutput

func (DomainNameEndpointConfigurationPtrOutput) Types added in v1.19.0 

func (o DomainNameEndpointConfigurationPtrOutput) Types() pulumi.StringOutput

A list of endpoint types. This resource currently only supports managing a single value. Valid values: `EDGE` or `REGIONAL`. If unspecified, defaults to `EDGE`. Must be declared as `REGIONAL` in non-Commercial partitions. Refer to the [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-regional-api.html) for more information on the difference between edge-optimized and regional APIs.

type DomainNameState 

type DomainNameState struct {
	// Amazon Resource Name (ARN)
	Arn pulumi.StringPtrInput
	// The ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when an edge-optimized domain name is desired. Conflicts with `certificateName`, `certificateBody`, `certificateChain`, `certificatePrivateKey`, `regionalCertificateArn`, and `regionalCertificateName`.
	CertificateArn pulumi.StringPtrInput
	// The certificate issued for the domain name
	// being registered, in PEM format. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`, `regionalCertificateArn`, and
	// `regionalCertificateName`.
	CertificateBody pulumi.StringPtrInput
	// The certificate for the CA that issued the
	// certificate, along with any intermediate CA certificates required to
	// create an unbroken chain to a certificate trusted by the intended API clients. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`,
	// `regionalCertificateArn`, and `regionalCertificateName`.
	CertificateChain pulumi.StringPtrInput
	// The unique name to use when registering this
	// certificate as an IAM server certificate. Conflicts with `certificateArn`, `regionalCertificateArn`, and
	// `regionalCertificateName`. Required if `certificateArn` is not set.
	CertificateName pulumi.StringPtrInput
	// The private key associated with the
	// domain certificate given in `certificateBody`. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificateArn`, `regionalCertificateArn`, and `regionalCertificateName`.
	CertificatePrivateKey pulumi.StringPtrInput
	// The upload date associated with the domain certificate.
	CertificateUploadDate pulumi.StringPtrInput
	// The hostname created by Cloudfront to represent
	// the distribution that implements this domain name mapping.
	CloudfrontDomainName pulumi.StringPtrInput
	// For convenience, the hosted zone ID (`Z2FDTNDATAQYW2`)
	// that can be used to create a Route53 alias record for the distribution.
	CloudfrontZoneId pulumi.StringPtrInput
	// The fully-qualified domain name to register
	DomainName pulumi.StringPtrInput
	// Configuration block defining API endpoint information including type. Defined below.
	EndpointConfiguration DomainNameEndpointConfigurationPtrInput
	// The ARN for an AWS-managed certificate. AWS Certificate Manager is the only supported source. Used when a regional domain name is desired. Conflicts with `certificateArn`, `certificateName`, `certificateBody`, `certificateChain`, and `certificatePrivateKey`.
	RegionalCertificateArn pulumi.StringPtrInput
	// The user-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts with `certificateArn`, `certificateName`, `certificateBody`, `certificateChain`, and
	// `certificatePrivateKey`.
	RegionalCertificateName pulumi.StringPtrInput
	// The hostname for the custom domain's regional endpoint.
	RegionalDomainName pulumi.StringPtrInput
	// The hosted zone ID that can be used to create a Route53 alias record for the regional endpoint.
	RegionalZoneId pulumi.StringPtrInput
	// The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are `TLS_1_0` and `TLS_1_2`. Must be configured to perform drift detection.
	SecurityPolicy pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
}

func (DomainNameState) ElementType added in v1.19.0 

func (DomainNameState) ElementType() reflect.Type

type GetKeyArgs added in v0.16.3 

type GetKeyArgs struct {
	// The ID of the API Key to look up.
	Id   string                 `pulumi:"id"`
	Tags map[string]interface{} `pulumi:"tags"`
}

A collection of arguments for invoking getKey.

type GetKeyResult added in v0.16.3 

type GetKeyResult struct {
	// The date and time when the API Key was created.
	CreatedDate string `pulumi:"createdDate"`
	// The description of the API Key.
	Description string `pulumi:"description"`
	// Specifies whether the API Key is enabled.
	Enabled bool `pulumi:"enabled"`
	// Set to the ID of the API Key.
	Id string `pulumi:"id"`
	// The date and time when the API Key was last updated.
	LastUpdatedDate string `pulumi:"lastUpdatedDate"`
	// Set to the name of the API Key.
	Name string `pulumi:"name"`
	// A mapping of tags for the resource.
	Tags map[string]interface{} `pulumi:"tags"`
	// Set to the value of the API Key.
	Value string `pulumi:"value"`
}

A collection of values returned by getKey.

func GetKey added in v1.19.0 

func GetKey(ctx *pulumi.Context, args *GetKeyArgs, opts ...pulumi.InvokeOption) (*GetKeyResult, error)

Use this data source to get the name and value of a pre-existing API Key, for example to supply credentials for a dependency microservice.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/api_gateway_api_key.html.markdown.

type Integration 

type Integration struct {
	pulumi.CustomResourceState

	// A list of cache key parameters for the integration.
	CacheKeyParameters pulumi.StringArrayOutput `pulumi:"cacheKeyParameters"`
	// The integration's cache namespace.
	CacheNamespace pulumi.StringOutput `pulumi:"cacheNamespace"`
	// The id of the VpcLink used for the integration. **Required** if `connectionType` is `VPC_LINK`
	ConnectionId pulumi.StringPtrOutput `pulumi:"connectionId"`
	// The integration input's [connectionType](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#connectionType). Valid values are `INTERNET` (default for connections through the public routable internet), and `VPC_LINK` (for private connections between API Gateway and a network load balancer in a VPC).
	ConnectionType pulumi.StringPtrOutput `pulumi:"connectionType"`
	// Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
	ContentHandling pulumi.StringPtrOutput `pulumi:"contentHandling"`
	// The credentials required for the integration. For `AWS` integrations, 2 options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's ARN. To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\*:user/\*`.
	Credentials pulumi.StringPtrOutput `pulumi:"credentials"`
	// The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`, `ANY`)
	// when calling the associated resource.
	HttpMethod pulumi.StringOutput `pulumi:"httpMethod"`
	// The integration HTTP method
	// (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONs`, `ANY`, `PATCH`) specifying how API Gateway will interact with the back end.
	// **Required** if `type` is `AWS`, `AWS_PROXY`, `HTTP` or `HTTP_PROXY`.
	// Not all methods are compatible with all `AWS` integrations.
	// e.g. Lambda function [can only be invoked](https://github.com/awslabs/aws-apigateway-importer/issues/9#issuecomment-129651005) via `POST`.
	IntegrationHttpMethod pulumi.StringPtrOutput `pulumi:"integrationHttpMethod"`
	// The integration passthrough behavior (`WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, `NEVER`).  **Required** if `requestTemplates` is used.
	PassthroughBehavior pulumi.StringOutput `pulumi:"passthroughBehavior"`
	// A map of request query string parameters and headers that should be passed to the backend responder.
	// For example: `requestParameters = { "integration.request.header.X-Some-Other-Header" = "method.request.header.X-Some-Header" }`
	RequestParameters pulumi.StringMapOutput `pulumi:"requestParameters"`
	// A map of the integration's request templates.
	RequestTemplates pulumi.StringMapOutput `pulumi:"requestTemplates"`
	// The API resource ID.
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// The ID of the associated REST API.
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds.
	TimeoutMilliseconds pulumi.IntPtrOutput `pulumi:"timeoutMilliseconds"`
	// The integration input's [type](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/). Valid values are `HTTP` (for HTTP backends), `MOCK` (not calling any real backend), `AWS` (for AWS services), `AWS_PROXY` (for Lambda proxy integration) and `HTTP_PROXY` (for HTTP proxy integration). An `HTTP` or `HTTP_PROXY` integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
	Type pulumi.StringOutput `pulumi:"type"`
	// The input's URI. **Required** if `type` is `AWS`, `AWS_PROXY`, `HTTP` or `HTTP_PROXY`.
	// For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification . For AWS integrations, the URI should be of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}`. `region`, `subdomain` and `service` are used to determine the right endpoint.
	// e.g. `arn:aws:apigateway:eu-west-1:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-1:012345678901:function:my-func/invocations`
	Uri pulumi.StringPtrOutput `pulumi:"uri"`
}

Provides an HTTP Method Integration for an API Gateway Integration.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_integration.html.markdown.

func GetIntegration 

func GetIntegration(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IntegrationState, opts ...pulumi.ResourceOption) (*Integration, error)

GetIntegration gets an existing Integration resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIntegration 

func NewIntegration(ctx *pulumi.Context,
	name string, args *IntegrationArgs, opts ...pulumi.ResourceOption) (*Integration, error)

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

type IntegrationArgs 

type IntegrationArgs struct {
	// A list of cache key parameters for the integration.
	CacheKeyParameters pulumi.StringArrayInput
	// The integration's cache namespace.
	CacheNamespace pulumi.StringPtrInput
	// The id of the VpcLink used for the integration. **Required** if `connectionType` is `VPC_LINK`
	ConnectionId pulumi.StringPtrInput
	// The integration input's [connectionType](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#connectionType). Valid values are `INTERNET` (default for connections through the public routable internet), and `VPC_LINK` (for private connections between API Gateway and a network load balancer in a VPC).
	ConnectionType pulumi.StringPtrInput
	// Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
	ContentHandling pulumi.StringPtrInput
	// The credentials required for the integration. For `AWS` integrations, 2 options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's ARN. To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\*:user/\*`.
	Credentials pulumi.StringPtrInput
	// The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`, `ANY`)
	// when calling the associated resource.
	HttpMethod pulumi.StringInput
	// The integration HTTP method
	// (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONs`, `ANY`, `PATCH`) specifying how API Gateway will interact with the back end.
	// **Required** if `type` is `AWS`, `AWS_PROXY`, `HTTP` or `HTTP_PROXY`.
	// Not all methods are compatible with all `AWS` integrations.
	// e.g. Lambda function [can only be invoked](https://github.com/awslabs/aws-apigateway-importer/issues/9#issuecomment-129651005) via `POST`.
	IntegrationHttpMethod pulumi.StringPtrInput
	// The integration passthrough behavior (`WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, `NEVER`).  **Required** if `requestTemplates` is used.
	PassthroughBehavior pulumi.StringPtrInput
	// A map of request query string parameters and headers that should be passed to the backend responder.
	// For example: `requestParameters = { "integration.request.header.X-Some-Other-Header" = "method.request.header.X-Some-Header" }`
	RequestParameters pulumi.StringMapInput
	// A map of the integration's request templates.
	RequestTemplates pulumi.StringMapInput
	// The API resource ID.
	ResourceId pulumi.StringInput
	// The ID of the associated REST API.
	RestApi pulumi.StringInput
	// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds.
	TimeoutMilliseconds pulumi.IntPtrInput
	// The integration input's [type](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/). Valid values are `HTTP` (for HTTP backends), `MOCK` (not calling any real backend), `AWS` (for AWS services), `AWS_PROXY` (for Lambda proxy integration) and `HTTP_PROXY` (for HTTP proxy integration). An `HTTP` or `HTTP_PROXY` integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
	Type pulumi.StringInput
	// The input's URI. **Required** if `type` is `AWS`, `AWS_PROXY`, `HTTP` or `HTTP_PROXY`.
	// For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification . For AWS integrations, the URI should be of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}`. `region`, `subdomain` and `service` are used to determine the right endpoint.
	// e.g. `arn:aws:apigateway:eu-west-1:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-1:012345678901:function:my-func/invocations`
	Uri pulumi.StringPtrInput
}

The set of arguments for constructing a Integration resource.

func (IntegrationArgs) ElementType added in v1.19.0 

func (IntegrationArgs) ElementType() reflect.Type

type IntegrationResponse 

type IntegrationResponse struct {
	pulumi.CustomResourceState

	// Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
	ContentHandling pulumi.StringPtrOutput `pulumi:"contentHandling"`
	// The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringOutput `pulumi:"httpMethod"`
	// The API resource ID
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// A map of response parameters that can be read from the backend response.
	// For example: `responseParameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }`
	ResponseParameters pulumi.StringMapOutput `pulumi:"responseParameters"`
	// A map specifying the templates used to transform the integration response body
	ResponseTemplates pulumi.StringMapOutput `pulumi:"responseTemplates"`
	// The ID of the associated REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// Specifies the regular expression pattern used to choose
	// an integration response based on the response from the backend. Setting this to `-` makes the integration the default one.
	// If the backend is an `AWS` Lambda function, the AWS Lambda function error header is matched.
	// For all other `HTTP` and `AWS` backends, the HTTP status code is matched.
	SelectionPattern pulumi.StringPtrOutput `pulumi:"selectionPattern"`
	// The HTTP status code
	StatusCode pulumi.StringOutput `pulumi:"statusCode"`
}

Provides an HTTP Method Integration Response for an API Gateway Resource.

> **Note:** Depends on having `apigateway.Integration` inside your rest api. To ensure this you might need to add an explicit `dependsOn` for clean runs.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_integration_response.html.markdown.

func GetIntegrationResponse 

func GetIntegrationResponse(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IntegrationResponseState, opts ...pulumi.ResourceOption) (*IntegrationResponse, error)

GetIntegrationResponse gets an existing IntegrationResponse resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIntegrationResponse 

func NewIntegrationResponse(ctx *pulumi.Context,
	name string, args *IntegrationResponseArgs, opts ...pulumi.ResourceOption) (*IntegrationResponse, error)

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

type IntegrationResponseArgs 

type IntegrationResponseArgs struct {
	// Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
	ContentHandling pulumi.StringPtrInput
	// The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringInput
	// The API resource ID
	ResourceId pulumi.StringInput
	// A map of response parameters that can be read from the backend response.
	// For example: `responseParameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }`
	ResponseParameters pulumi.StringMapInput
	// A map specifying the templates used to transform the integration response body
	ResponseTemplates pulumi.StringMapInput
	// The ID of the associated REST API
	RestApi pulumi.StringInput
	// Specifies the regular expression pattern used to choose
	// an integration response based on the response from the backend. Setting this to `-` makes the integration the default one.
	// If the backend is an `AWS` Lambda function, the AWS Lambda function error header is matched.
	// For all other `HTTP` and `AWS` backends, the HTTP status code is matched.
	SelectionPattern pulumi.StringPtrInput
	// The HTTP status code
	StatusCode pulumi.StringInput
}

The set of arguments for constructing a IntegrationResponse resource.

func (IntegrationResponseArgs) ElementType added in v1.19.0 

func (IntegrationResponseArgs) ElementType() reflect.Type

type IntegrationResponseState 

type IntegrationResponseState struct {
	// Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
	ContentHandling pulumi.StringPtrInput
	// The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringPtrInput
	// The API resource ID
	ResourceId pulumi.StringPtrInput
	// A map of response parameters that can be read from the backend response.
	// For example: `responseParameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }`
	ResponseParameters pulumi.StringMapInput
	// A map specifying the templates used to transform the integration response body
	ResponseTemplates pulumi.StringMapInput
	// The ID of the associated REST API
	RestApi pulumi.StringPtrInput
	// Specifies the regular expression pattern used to choose
	// an integration response based on the response from the backend. Setting this to `-` makes the integration the default one.
	// If the backend is an `AWS` Lambda function, the AWS Lambda function error header is matched.
	// For all other `HTTP` and `AWS` backends, the HTTP status code is matched.
	SelectionPattern pulumi.StringPtrInput
	// The HTTP status code
	StatusCode pulumi.StringPtrInput
}

func (IntegrationResponseState) ElementType added in v1.19.0 

func (IntegrationResponseState) ElementType() reflect.Type

type IntegrationState 

type IntegrationState struct {
	// A list of cache key parameters for the integration.
	CacheKeyParameters pulumi.StringArrayInput
	// The integration's cache namespace.
	CacheNamespace pulumi.StringPtrInput
	// The id of the VpcLink used for the integration. **Required** if `connectionType` is `VPC_LINK`
	ConnectionId pulumi.StringPtrInput
	// The integration input's [connectionType](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#connectionType). Valid values are `INTERNET` (default for connections through the public routable internet), and `VPC_LINK` (for private connections between API Gateway and a network load balancer in a VPC).
	ConnectionType pulumi.StringPtrInput
	// Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
	ContentHandling pulumi.StringPtrInput
	// The credentials required for the integration. For `AWS` integrations, 2 options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's ARN. To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\*:user/\*`.
	Credentials pulumi.StringPtrInput
	// The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`, `ANY`)
	// when calling the associated resource.
	HttpMethod pulumi.StringPtrInput
	// The integration HTTP method
	// (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONs`, `ANY`, `PATCH`) specifying how API Gateway will interact with the back end.
	// **Required** if `type` is `AWS`, `AWS_PROXY`, `HTTP` or `HTTP_PROXY`.
	// Not all methods are compatible with all `AWS` integrations.
	// e.g. Lambda function [can only be invoked](https://github.com/awslabs/aws-apigateway-importer/issues/9#issuecomment-129651005) via `POST`.
	IntegrationHttpMethod pulumi.StringPtrInput
	// The integration passthrough behavior (`WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, `NEVER`).  **Required** if `requestTemplates` is used.
	PassthroughBehavior pulumi.StringPtrInput
	// A map of request query string parameters and headers that should be passed to the backend responder.
	// For example: `requestParameters = { "integration.request.header.X-Some-Other-Header" = "method.request.header.X-Some-Header" }`
	RequestParameters pulumi.StringMapInput
	// A map of the integration's request templates.
	RequestTemplates pulumi.StringMapInput
	// The API resource ID.
	ResourceId pulumi.StringPtrInput
	// The ID of the associated REST API.
	RestApi pulumi.StringPtrInput
	// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds.
	TimeoutMilliseconds pulumi.IntPtrInput
	// The integration input's [type](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/). Valid values are `HTTP` (for HTTP backends), `MOCK` (not calling any real backend), `AWS` (for AWS services), `AWS_PROXY` (for Lambda proxy integration) and `HTTP_PROXY` (for HTTP proxy integration). An `HTTP` or `HTTP_PROXY` integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
	Type pulumi.StringPtrInput
	// The input's URI. **Required** if `type` is `AWS`, `AWS_PROXY`, `HTTP` or `HTTP_PROXY`.
	// For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification . For AWS integrations, the URI should be of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}`. `region`, `subdomain` and `service` are used to determine the right endpoint.
	// e.g. `arn:aws:apigateway:eu-west-1:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-1:012345678901:function:my-func/invocations`
	Uri pulumi.StringPtrInput
}

func (IntegrationState) ElementType added in v1.19.0 

func (IntegrationState) ElementType() reflect.Type

type LookupResourceArgs added in v1.19.0 

type LookupResourceArgs struct {
	// The full path of the resource.  If no path is found, an error will be returned.
	Path string `pulumi:"path"`
	// The REST API id that owns the resource. If no REST API is found, an error will be returned.
	RestApiId string `pulumi:"restApiId"`
}

A collection of arguments for invoking getResource.

type LookupResourceResult added in v1.19.0 

type LookupResourceResult struct {
	// id is the provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Set to the ID of the parent Resource.
	ParentId string `pulumi:"parentId"`
	Path     string `pulumi:"path"`
	// Set to the path relative to the parent Resource.
	PathPart  string `pulumi:"pathPart"`
	RestApiId string `pulumi:"restApiId"`
}

A collection of values returned by getResource.

func LookupResource added in v0.16.0 

func LookupResource(ctx *pulumi.Context, args *LookupResourceArgs, opts ...pulumi.InvokeOption) (*LookupResourceResult, error)

Use this data source to get the id of a Resource in API Gateway. To fetch the Resource, you must provide the REST API id as well as the full path.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/api_gateway_resource.html.markdown.

type LookupRestApiArgs added in v1.19.0 

type LookupRestApiArgs struct {
	// The name of the REST API to look up. If no REST API is found with this name, an error will be returned.
	// If multiple REST APIs are found with this name, an error will be returned.
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getRestApi.

type LookupRestApiResult added in v1.19.0 

type LookupRestApiResult struct {
	// id is the provider-assigned unique ID for this managed resource.
	Id   string `pulumi:"id"`
	Name string `pulumi:"name"`
	// Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'.
	RootResourceId string `pulumi:"rootResourceId"`
}

A collection of values returned by getRestApi.

func LookupRestApi 

func LookupRestApi(ctx *pulumi.Context, args *LookupRestApiArgs, opts ...pulumi.InvokeOption) (*LookupRestApiResult, error)

Use this data source to get the id and rootResourceId of a REST API in API Gateway. To fetch the REST API you must provide a name to match against. As there is no unique name constraint on REST APIs this data source will error if there is more than one match.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/api_gateway_rest_api.html.markdown.

type LookupVpcLinkArgs added in v1.19.0 

type LookupVpcLinkArgs struct {
	// The name of the API Gateway VPC Link to look up. If no API Gateway VPC Link is found with this name, an error will be returned.
	// If multiple API Gateway VPC Links are found with this name, an error will be returned.
	Name string                 `pulumi:"name"`
	Tags map[string]interface{} `pulumi:"tags"`
}

A collection of arguments for invoking getVpcLink.

type LookupVpcLinkResult added in v1.19.0 

type LookupVpcLinkResult struct {
	// The description of the VPC link.
	Description string `pulumi:"description"`
	// Set to the ID of the found API Gateway VPC Link.
	Id   string `pulumi:"id"`
	Name string `pulumi:"name"`
	// The status of the VPC link.
	Status string `pulumi:"status"`
	// The status message of the VPC link.
	StatusMessage string `pulumi:"statusMessage"`
	// Key-value mapping of resource tags
	Tags map[string]interface{} `pulumi:"tags"`
	// The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
	TargetArns []string `pulumi:"targetArns"`
}

A collection of values returned by getVpcLink. 

func LookupVpcLink(ctx *pulumi.Context, args *LookupVpcLinkArgs, opts ...pulumi.InvokeOption) (*LookupVpcLinkResult, error)

Use this data source to get the id of a VPC Link in API Gateway. To fetch the VPC Link you must provide a name to match against. As there is no unique name constraint on API Gateway VPC Links this data source will error if there is more than one match.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/api_gateway_vpc_link.html.markdown.

type Method 

type Method struct {
	pulumi.CustomResourceState

	// Specify if the method requires an API key
	ApiKeyRequired pulumi.BoolPtrOutput `pulumi:"apiKeyRequired"`
	// The type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization pulumi.StringOutput `pulumi:"authorization"`
	// The authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes pulumi.StringArrayOutput `pulumi:"authorizationScopes"`
	// The authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId pulumi.StringPtrOutput `pulumi:"authorizerId"`
	// The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringOutput `pulumi:"httpMethod"`
	// A map of the API models used for the request's content type
	// where key is the content type (e.g. `application/json`)
	// and value is either `Error`, `Empty` (built-in models) or `apigateway.Model`'s `name`.
	RequestModels pulumi.StringMapOutput `pulumi:"requestModels"`
	// A map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (`true`) or optional (`false`).
	// For example: `requestParameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true}` would define that the header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
	RequestParameters pulumi.BoolMapOutput `pulumi:"requestParameters"`
	// The ID of a `apigateway.RequestValidator`
	RequestValidatorId pulumi.StringPtrOutput `pulumi:"requestValidatorId"`
	// The API resource ID
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// The ID of the associated REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
}

Provides a HTTP Method for an API Gateway Resource.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_method.html.markdown.

func GetMethod 

func GetMethod(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MethodState, opts ...pulumi.ResourceOption) (*Method, error)

GetMethod gets an existing Method resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMethod 

func NewMethod(ctx *pulumi.Context,
	name string, args *MethodArgs, opts ...pulumi.ResourceOption) (*Method, error)

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

type MethodArgs 

type MethodArgs struct {
	// Specify if the method requires an API key
	ApiKeyRequired pulumi.BoolPtrInput
	// The type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization pulumi.StringInput
	// The authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes pulumi.StringArrayInput
	// The authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId pulumi.StringPtrInput
	// The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringInput
	// A map of the API models used for the request's content type
	// where key is the content type (e.g. `application/json`)
	// and value is either `Error`, `Empty` (built-in models) or `apigateway.Model`'s `name`.
	RequestModels pulumi.StringMapInput
	// A map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (`true`) or optional (`false`).
	// For example: `requestParameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true}` would define that the header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
	RequestParameters pulumi.BoolMapInput
	// The ID of a `apigateway.RequestValidator`
	RequestValidatorId pulumi.StringPtrInput
	// The API resource ID
	ResourceId pulumi.StringInput
	// The ID of the associated REST API
	RestApi pulumi.StringInput
}

The set of arguments for constructing a Method resource.

func (MethodArgs) ElementType added in v1.19.0 

func (MethodArgs) ElementType() reflect.Type

type MethodResponse 

type MethodResponse struct {
	pulumi.CustomResourceState

	// The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringOutput `pulumi:"httpMethod"`
	// The API resource ID
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// A map of the API models used for the response's content type
	ResponseModels pulumi.StringMapOutput `pulumi:"responseModels"`
	// A map of response parameters that can be sent to the caller.
	// For example: `responseParameters = { "method.response.header.X-Some-Header" = true }`
	// would define that the header `X-Some-Header` can be provided on the response.
	ResponseParameters pulumi.BoolMapOutput `pulumi:"responseParameters"`
	// The ID of the associated REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// The HTTP status code
	StatusCode pulumi.StringOutput `pulumi:"statusCode"`
}

Provides an HTTP Method Response for an API Gateway Resource.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_method_response.html.markdown.

func GetMethodResponse 

func GetMethodResponse(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MethodResponseState, opts ...pulumi.ResourceOption) (*MethodResponse, error)

GetMethodResponse gets an existing MethodResponse resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMethodResponse 

func NewMethodResponse(ctx *pulumi.Context,
	name string, args *MethodResponseArgs, opts ...pulumi.ResourceOption) (*MethodResponse, error)

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

type MethodResponseArgs 

type MethodResponseArgs struct {
	// The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringInput
	// The API resource ID
	ResourceId pulumi.StringInput
	// A map of the API models used for the response's content type
	ResponseModels pulumi.StringMapInput
	// A map of response parameters that can be sent to the caller.
	// For example: `responseParameters = { "method.response.header.X-Some-Header" = true }`
	// would define that the header `X-Some-Header` can be provided on the response.
	ResponseParameters pulumi.BoolMapInput
	// The ID of the associated REST API
	RestApi pulumi.StringInput
	// The HTTP status code
	StatusCode pulumi.StringInput
}

The set of arguments for constructing a MethodResponse resource.

func (MethodResponseArgs) ElementType added in v1.19.0 

func (MethodResponseArgs) ElementType() reflect.Type

type MethodResponseState 

type MethodResponseState struct {
	// The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringPtrInput
	// The API resource ID
	ResourceId pulumi.StringPtrInput
	// A map of the API models used for the response's content type
	ResponseModels pulumi.StringMapInput
	// A map of response parameters that can be sent to the caller.
	// For example: `responseParameters = { "method.response.header.X-Some-Header" = true }`
	// would define that the header `X-Some-Header` can be provided on the response.
	ResponseParameters pulumi.BoolMapInput
	// The ID of the associated REST API
	RestApi pulumi.StringPtrInput
	// The HTTP status code
	StatusCode pulumi.StringPtrInput
}

func (MethodResponseState) ElementType added in v1.19.0 

func (MethodResponseState) ElementType() reflect.Type

type MethodSettings 

type MethodSettings struct {
	pulumi.CustomResourceState

	// Method path defined as `{resource_path}/{http_method}` for an individual method override, or `*/*` for overriding all methods in the stage.
	MethodPath pulumi.StringOutput `pulumi:"methodPath"`
	// The ID of the REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// The settings block, see below.
	Settings MethodSettingsSettingsOutput `pulumi:"settings"`
	// The name of the stage
	StageName pulumi.StringOutput `pulumi:"stageName"`
}

Provides an API Gateway Method Settings, e.g. logging or monitoring.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_method_settings.html.markdown.

func GetMethodSettings 

func GetMethodSettings(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MethodSettingsState, opts ...pulumi.ResourceOption) (*MethodSettings, error)

GetMethodSettings gets an existing MethodSettings resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMethodSettings 

func NewMethodSettings(ctx *pulumi.Context,
	name string, args *MethodSettingsArgs, opts ...pulumi.ResourceOption) (*MethodSettings, error)

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

type MethodSettingsArgs 

type MethodSettingsArgs struct {
	// Method path defined as `{resource_path}/{http_method}` for an individual method override, or `*/*` for overriding all methods in the stage.
	MethodPath pulumi.StringInput
	// The ID of the REST API
	RestApi pulumi.StringInput
	// The settings block, see below.
	Settings MethodSettingsSettingsInput
	// The name of the stage
	StageName pulumi.StringInput
}

The set of arguments for constructing a MethodSettings resource.

func (MethodSettingsArgs) ElementType added in v1.19.0 

func (MethodSettingsArgs) ElementType() reflect.Type

type MethodSettingsSettings added in v1.19.0 

type MethodSettingsSettings struct {
	// Specifies whether the cached responses are encrypted.
	CacheDataEncrypted *bool `pulumi:"cacheDataEncrypted"`
	// Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
	CacheTtlInSeconds *int `pulumi:"cacheTtlInSeconds"`
	// Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
	CachingEnabled *bool `pulumi:"cachingEnabled"`
	// Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
	DataTraceEnabled *bool `pulumi:"dataTraceEnabled"`
	// Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The available levels are `OFF`, `ERROR`, and `INFO`.
	LoggingLevel *string `pulumi:"loggingLevel"`
	// Specifies whether Amazon CloudWatch metrics are enabled for this method.
	MetricsEnabled *bool `pulumi:"metricsEnabled"`
	// Specifies whether authorization is required for a cache invalidation request.
	RequireAuthorizationForCacheControl *bool `pulumi:"requireAuthorizationForCacheControl"`
	// Specifies the throttling burst limit.
	ThrottlingBurstLimit *int `pulumi:"throttlingBurstLimit"`
	// Specifies the throttling rate limit.
	ThrottlingRateLimit *float64 `pulumi:"throttlingRateLimit"`
	// Specifies how to handle unauthorized requests for cache invalidation. The available values are `FAIL_WITH_403`, `SUCCEED_WITH_RESPONSE_HEADER`, `SUCCEED_WITHOUT_RESPONSE_HEADER`.
	UnauthorizedCacheControlHeaderStrategy *string `pulumi:"unauthorizedCacheControlHeaderStrategy"`
}

type MethodSettingsSettingsArgs added in v1.19.0 

type MethodSettingsSettingsArgs struct {
	// Specifies whether the cached responses are encrypted.
	CacheDataEncrypted pulumi.BoolPtrInput `pulumi:"cacheDataEncrypted"`
	// Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
	CacheTtlInSeconds pulumi.IntPtrInput `pulumi:"cacheTtlInSeconds"`
	// Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
	CachingEnabled pulumi.BoolPtrInput `pulumi:"cachingEnabled"`
	// Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
	DataTraceEnabled pulumi.BoolPtrInput `pulumi:"dataTraceEnabled"`
	// Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The available levels are `OFF`, `ERROR`, and `INFO`.
	LoggingLevel pulumi.StringPtrInput `pulumi:"loggingLevel"`
	// Specifies whether Amazon CloudWatch metrics are enabled for this method.
	MetricsEnabled pulumi.BoolPtrInput `pulumi:"metricsEnabled"`
	// Specifies whether authorization is required for a cache invalidation request.
	RequireAuthorizationForCacheControl pulumi.BoolPtrInput `pulumi:"requireAuthorizationForCacheControl"`
	// Specifies the throttling burst limit.
	ThrottlingBurstLimit pulumi.IntPtrInput `pulumi:"throttlingBurstLimit"`
	// Specifies the throttling rate limit.
	ThrottlingRateLimit pulumi.Float64PtrInput `pulumi:"throttlingRateLimit"`
	// Specifies how to handle unauthorized requests for cache invalidation. The available values are `FAIL_WITH_403`, `SUCCEED_WITH_RESPONSE_HEADER`, `SUCCEED_WITHOUT_RESPONSE_HEADER`.
	UnauthorizedCacheControlHeaderStrategy pulumi.StringPtrInput `pulumi:"unauthorizedCacheControlHeaderStrategy"`
}

func (MethodSettingsSettingsArgs) ElementType added in v1.19.0 

func (MethodSettingsSettingsArgs) ElementType() reflect.Type

func (MethodSettingsSettingsArgs) ToMethodSettingsSettingsOutput added in v1.19.0 

func (i MethodSettingsSettingsArgs) ToMethodSettingsSettingsOutput() MethodSettingsSettingsOutput

func (MethodSettingsSettingsArgs) ToMethodSettingsSettingsOutputWithContext added in v1.19.0 

func (i MethodSettingsSettingsArgs) ToMethodSettingsSettingsOutputWithContext(ctx context.Context) MethodSettingsSettingsOutput

func (MethodSettingsSettingsArgs) ToMethodSettingsSettingsPtrOutput added in v1.19.0 

func (i MethodSettingsSettingsArgs) ToMethodSettingsSettingsPtrOutput() MethodSettingsSettingsPtrOutput

func (MethodSettingsSettingsArgs) ToMethodSettingsSettingsPtrOutputWithContext added in v1.19.0 

func (i MethodSettingsSettingsArgs) ToMethodSettingsSettingsPtrOutputWithContext(ctx context.Context) MethodSettingsSettingsPtrOutput

type MethodSettingsSettingsInput added in v1.19.0 

type MethodSettingsSettingsInput interface {
	pulumi.Input

	ToMethodSettingsSettingsOutput() MethodSettingsSettingsOutput
	ToMethodSettingsSettingsOutputWithContext(context.Context) MethodSettingsSettingsOutput
}

type MethodSettingsSettingsOutput added in v1.19.0 

type MethodSettingsSettingsOutput struct{ *pulumi.OutputState }

func (MethodSettingsSettingsOutput) CacheDataEncrypted added in v1.19.0 

func (o MethodSettingsSettingsOutput) CacheDataEncrypted() pulumi.BoolPtrOutput

Specifies whether the cached responses are encrypted.

func (MethodSettingsSettingsOutput) CacheTtlInSeconds added in v1.19.0 

func (o MethodSettingsSettingsOutput) CacheTtlInSeconds() pulumi.IntPtrOutput

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.

func (MethodSettingsSettingsOutput) CachingEnabled added in v1.19.0 

func (o MethodSettingsSettingsOutput) CachingEnabled() pulumi.BoolPtrOutput

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.

func (MethodSettingsSettingsOutput) DataTraceEnabled added in v1.19.0 

func (o MethodSettingsSettingsOutput) DataTraceEnabled() pulumi.BoolPtrOutput

Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.

func (MethodSettingsSettingsOutput) ElementType added in v1.19.0 

func (MethodSettingsSettingsOutput) ElementType() reflect.Type

func (MethodSettingsSettingsOutput) LoggingLevel added in v1.19.0 

func (o MethodSettingsSettingsOutput) LoggingLevel() pulumi.StringPtrOutput

Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The available levels are `OFF`, `ERROR`, and `INFO`.

func (MethodSettingsSettingsOutput) MetricsEnabled added in v1.19.0 

func (o MethodSettingsSettingsOutput) MetricsEnabled() pulumi.BoolPtrOutput

Specifies whether Amazon CloudWatch metrics are enabled for this method.

func (MethodSettingsSettingsOutput) RequireAuthorizationForCacheControl added in v1.19.0 

func (o MethodSettingsSettingsOutput) RequireAuthorizationForCacheControl() pulumi.BoolPtrOutput

Specifies whether authorization is required for a cache invalidation request.

func (MethodSettingsSettingsOutput) ThrottlingBurstLimit added in v1.19.0 

func (o MethodSettingsSettingsOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

Specifies the throttling burst limit.

func (MethodSettingsSettingsOutput) ThrottlingRateLimit added in v1.19.0 

func (o MethodSettingsSettingsOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput

Specifies the throttling rate limit.

func (MethodSettingsSettingsOutput) ToMethodSettingsSettingsOutput added in v1.19.0 

func (o MethodSettingsSettingsOutput) ToMethodSettingsSettingsOutput() MethodSettingsSettingsOutput

func (MethodSettingsSettingsOutput) ToMethodSettingsSettingsOutputWithContext added in v1.19.0 

func (o MethodSettingsSettingsOutput) ToMethodSettingsSettingsOutputWithContext(ctx context.Context) MethodSettingsSettingsOutput

func (MethodSettingsSettingsOutput) ToMethodSettingsSettingsPtrOutput added in v1.19.0 

func (o MethodSettingsSettingsOutput) ToMethodSettingsSettingsPtrOutput() MethodSettingsSettingsPtrOutput

func (MethodSettingsSettingsOutput) ToMethodSettingsSettingsPtrOutputWithContext added in v1.19.0 

func (o MethodSettingsSettingsOutput) ToMethodSettingsSettingsPtrOutputWithContext(ctx context.Context) MethodSettingsSettingsPtrOutput

func (MethodSettingsSettingsOutput) UnauthorizedCacheControlHeaderStrategy added in v1.19.0 

func (o MethodSettingsSettingsOutput) UnauthorizedCacheControlHeaderStrategy() pulumi.StringPtrOutput

Specifies how to handle unauthorized requests for cache invalidation. The available values are `FAIL_WITH_403`, `SUCCEED_WITH_RESPONSE_HEADER`, `SUCCEED_WITHOUT_RESPONSE_HEADER`.

type MethodSettingsSettingsPtrInput added in v1.19.0 

type MethodSettingsSettingsPtrInput interface {
	pulumi.Input

	ToMethodSettingsSettingsPtrOutput() MethodSettingsSettingsPtrOutput
	ToMethodSettingsSettingsPtrOutputWithContext(context.Context) MethodSettingsSettingsPtrOutput
}

func MethodSettingsSettingsPtr added in v1.19.0 

func MethodSettingsSettingsPtr(v *MethodSettingsSettingsArgs) MethodSettingsSettingsPtrInput

type MethodSettingsSettingsPtrOutput added in v1.19.0 

type MethodSettingsSettingsPtrOutput struct{ *pulumi.OutputState }

func (MethodSettingsSettingsPtrOutput) CacheDataEncrypted added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) CacheDataEncrypted() pulumi.BoolPtrOutput

Specifies whether the cached responses are encrypted.

func (MethodSettingsSettingsPtrOutput) CacheTtlInSeconds added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) CacheTtlInSeconds() pulumi.IntPtrOutput

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.

func (MethodSettingsSettingsPtrOutput) CachingEnabled added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) CachingEnabled() pulumi.BoolPtrOutput

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.

func (MethodSettingsSettingsPtrOutput) DataTraceEnabled added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) DataTraceEnabled() pulumi.BoolPtrOutput

Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.

func (MethodSettingsSettingsPtrOutput) Elem added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) Elem() MethodSettingsSettingsOutput

func (MethodSettingsSettingsPtrOutput) ElementType added in v1.19.0 

func (MethodSettingsSettingsPtrOutput) ElementType() reflect.Type

func (MethodSettingsSettingsPtrOutput) LoggingLevel added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) LoggingLevel() pulumi.StringPtrOutput

Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The available levels are `OFF`, `ERROR`, and `INFO`.

func (MethodSettingsSettingsPtrOutput) MetricsEnabled added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) MetricsEnabled() pulumi.BoolPtrOutput

Specifies whether Amazon CloudWatch metrics are enabled for this method.

func (MethodSettingsSettingsPtrOutput) RequireAuthorizationForCacheControl added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) RequireAuthorizationForCacheControl() pulumi.BoolPtrOutput

Specifies whether authorization is required for a cache invalidation request.

func (MethodSettingsSettingsPtrOutput) ThrottlingBurstLimit added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

Specifies the throttling burst limit.

func (MethodSettingsSettingsPtrOutput) ThrottlingRateLimit added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput

Specifies the throttling rate limit.

func (MethodSettingsSettingsPtrOutput) ToMethodSettingsSettingsPtrOutput added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) ToMethodSettingsSettingsPtrOutput() MethodSettingsSettingsPtrOutput

func (MethodSettingsSettingsPtrOutput) ToMethodSettingsSettingsPtrOutputWithContext added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) ToMethodSettingsSettingsPtrOutputWithContext(ctx context.Context) MethodSettingsSettingsPtrOutput

func (MethodSettingsSettingsPtrOutput) UnauthorizedCacheControlHeaderStrategy added in v1.19.0 

func (o MethodSettingsSettingsPtrOutput) UnauthorizedCacheControlHeaderStrategy() pulumi.StringPtrOutput

Specifies how to handle unauthorized requests for cache invalidation. The available values are `FAIL_WITH_403`, `SUCCEED_WITH_RESPONSE_HEADER`, `SUCCEED_WITHOUT_RESPONSE_HEADER`.

type MethodSettingsState 

type MethodSettingsState struct {
	// Method path defined as `{resource_path}/{http_method}` for an individual method override, or `*/*` for overriding all methods in the stage.
	MethodPath pulumi.StringPtrInput
	// The ID of the REST API
	RestApi pulumi.StringPtrInput
	// The settings block, see below.
	Settings MethodSettingsSettingsPtrInput
	// The name of the stage
	StageName pulumi.StringPtrInput
}

func (MethodSettingsState) ElementType added in v1.19.0 

func (MethodSettingsState) ElementType() reflect.Type

type MethodState 

type MethodState struct {
	// Specify if the method requires an API key
	ApiKeyRequired pulumi.BoolPtrInput
	// The type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization pulumi.StringPtrInput
	// The authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes pulumi.StringArrayInput
	// The authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId pulumi.StringPtrInput
	// The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringPtrInput
	// A map of the API models used for the request's content type
	// where key is the content type (e.g. `application/json`)
	// and value is either `Error`, `Empty` (built-in models) or `apigateway.Model`'s `name`.
	RequestModels pulumi.StringMapInput
	// A map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (`true`) or optional (`false`).
	// For example: `requestParameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true}` would define that the header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
	RequestParameters pulumi.BoolMapInput
	// The ID of a `apigateway.RequestValidator`
	RequestValidatorId pulumi.StringPtrInput
	// The API resource ID
	ResourceId pulumi.StringPtrInput
	// The ID of the associated REST API
	RestApi pulumi.StringPtrInput
}

func (MethodState) ElementType added in v1.19.0 

func (MethodState) ElementType() reflect.Type

type Model 

type Model struct {
	pulumi.CustomResourceState

	// The content type of the model
	ContentType pulumi.StringOutput `pulumi:"contentType"`
	// The description of the model
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the model
	Name pulumi.StringOutput `pulumi:"name"`
	// The ID of the associated REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// The schema of the model in a JSON form
	Schema pulumi.StringPtrOutput `pulumi:"schema"`
}

Provides a Model for a API Gateway.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_model.html.markdown.

func GetModel 

func GetModel(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ModelState, opts ...pulumi.ResourceOption) (*Model, error)

GetModel gets an existing Model resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewModel 

func NewModel(ctx *pulumi.Context,
	name string, args *ModelArgs, opts ...pulumi.ResourceOption) (*Model, error)

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

type ModelArgs 

type ModelArgs struct {
	// The content type of the model
	ContentType pulumi.StringInput
	// The description of the model
	Description pulumi.StringPtrInput
	// The name of the model
	Name pulumi.StringPtrInput
	// The ID of the associated REST API
	RestApi pulumi.StringInput
	// The schema of the model in a JSON form
	Schema pulumi.StringPtrInput
}

The set of arguments for constructing a Model resource.

func (ModelArgs) ElementType added in v1.19.0 

func (ModelArgs) ElementType() reflect.Type

type ModelState 

type ModelState struct {
	// The content type of the model
	ContentType pulumi.StringPtrInput
	// The description of the model
	Description pulumi.StringPtrInput
	// The name of the model
	Name pulumi.StringPtrInput
	// The ID of the associated REST API
	RestApi pulumi.StringPtrInput
	// The schema of the model in a JSON form
	Schema pulumi.StringPtrInput
}

func (ModelState) ElementType added in v1.19.0 

func (ModelState) ElementType() reflect.Type

type RequestValidator 

type RequestValidator struct {
	pulumi.CustomResourceState

	// The name of the request validator
	Name pulumi.StringOutput `pulumi:"name"`
	// The ID of the associated Rest API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// Boolean whether to validate request body. Defaults to `false`.
	ValidateRequestBody pulumi.BoolPtrOutput `pulumi:"validateRequestBody"`
	// Boolean whether to validate request parameters. Defaults to `false`.
	ValidateRequestParameters pulumi.BoolPtrOutput `pulumi:"validateRequestParameters"`
}

Manages an API Gateway Request Validator.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_request_validator.html.markdown.

func GetRequestValidator 

func GetRequestValidator(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RequestValidatorState, opts ...pulumi.ResourceOption) (*RequestValidator, error)

GetRequestValidator gets an existing RequestValidator resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRequestValidator 

func NewRequestValidator(ctx *pulumi.Context,
	name string, args *RequestValidatorArgs, opts ...pulumi.ResourceOption) (*RequestValidator, error)

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

type RequestValidatorArgs 

type RequestValidatorArgs struct {
	// The name of the request validator
	Name pulumi.StringPtrInput
	// The ID of the associated Rest API
	RestApi pulumi.StringInput
	// Boolean whether to validate request body. Defaults to `false`.
	ValidateRequestBody pulumi.BoolPtrInput
	// Boolean whether to validate request parameters. Defaults to `false`.
	ValidateRequestParameters pulumi.BoolPtrInput
}

The set of arguments for constructing a RequestValidator resource.

func (RequestValidatorArgs) ElementType added in v1.19.0 

func (RequestValidatorArgs) ElementType() reflect.Type

type RequestValidatorState 

type RequestValidatorState struct {
	// The name of the request validator
	Name pulumi.StringPtrInput
	// The ID of the associated Rest API
	RestApi pulumi.StringPtrInput
	// Boolean whether to validate request body. Defaults to `false`.
	ValidateRequestBody pulumi.BoolPtrInput
	// Boolean whether to validate request parameters. Defaults to `false`.
	ValidateRequestParameters pulumi.BoolPtrInput
}

func (RequestValidatorState) ElementType added in v1.19.0 

func (RequestValidatorState) ElementType() reflect.Type

type Resource 

type Resource struct {
	pulumi.CustomResourceState

	// The ID of the parent API resource
	ParentId pulumi.StringOutput `pulumi:"parentId"`
	// The complete path for this API resource, including all parent paths.
	Path pulumi.StringOutput `pulumi:"path"`
	// The last path segment of this API resource.
	PathPart pulumi.StringOutput `pulumi:"pathPart"`
	// The ID of the associated REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
}

Provides an API Gateway Resource.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_resource.html.markdown.

func GetResource 

func GetResource(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourceState, opts ...pulumi.ResourceOption) (*Resource, error)

GetResource gets an existing Resource resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewResource 

func NewResource(ctx *pulumi.Context,
	name string, args *ResourceArgs, opts ...pulumi.ResourceOption) (*Resource, error)

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

type ResourceArgs 

type ResourceArgs struct {
	// The ID of the parent API resource
	ParentId pulumi.StringInput
	// The last path segment of this API resource.
	PathPart pulumi.StringInput
	// The ID of the associated REST API
	RestApi pulumi.StringInput
}

The set of arguments for constructing a Resource resource.

func (ResourceArgs) ElementType added in v1.19.0 

func (ResourceArgs) ElementType() reflect.Type

type ResourceState 

type ResourceState struct {
	// The ID of the parent API resource
	ParentId pulumi.StringPtrInput
	// The complete path for this API resource, including all parent paths.
	Path pulumi.StringPtrInput
	// The last path segment of this API resource.
	PathPart pulumi.StringPtrInput
	// The ID of the associated REST API
	RestApi pulumi.StringPtrInput
}

func (ResourceState) ElementType added in v1.19.0 

func (ResourceState) ElementType() reflect.Type

type Response 

type Response struct {
	pulumi.CustomResourceState

	// A map specifying the parameters (paths, query strings and headers) of the Gateway Response.
	ResponseParameters pulumi.StringMapOutput `pulumi:"responseParameters"`
	// A map specifying the templates used to transform the response body.
	ResponseTemplates pulumi.StringMapOutput `pulumi:"responseTemplates"`
	// The response type of the associated GatewayResponse.
	ResponseType pulumi.StringOutput `pulumi:"responseType"`
	// The string identifier of the associated REST API.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// The HTTP status code of the Gateway Response.
	StatusCode pulumi.StringPtrOutput `pulumi:"statusCode"`
}

Provides an API Gateway Gateway Response for a REST API Gateway.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_gateway_response.html.markdown.

func GetResponse 

func GetResponse(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResponseState, opts ...pulumi.ResourceOption) (*Response, error)

GetResponse gets an existing Response resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewResponse 

func NewResponse(ctx *pulumi.Context,
	name string, args *ResponseArgs, opts ...pulumi.ResourceOption) (*Response, error)

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

type ResponseArgs 

type ResponseArgs struct {
	// A map specifying the parameters (paths, query strings and headers) of the Gateway Response.
	ResponseParameters pulumi.StringMapInput
	// A map specifying the templates used to transform the response body.
	ResponseTemplates pulumi.StringMapInput
	// The response type of the associated GatewayResponse.
	ResponseType pulumi.StringInput
	// The string identifier of the associated REST API.
	RestApiId pulumi.StringInput
	// The HTTP status code of the Gateway Response.
	StatusCode pulumi.StringPtrInput
}

The set of arguments for constructing a Response resource.

func (ResponseArgs) ElementType added in v1.19.0 

func (ResponseArgs) ElementType() reflect.Type

type ResponseState 

type ResponseState struct {
	// A map specifying the parameters (paths, query strings and headers) of the Gateway Response.
	ResponseParameters pulumi.StringMapInput
	// A map specifying the templates used to transform the response body.
	ResponseTemplates pulumi.StringMapInput
	// The response type of the associated GatewayResponse.
	ResponseType pulumi.StringPtrInput
	// The string identifier of the associated REST API.
	RestApiId pulumi.StringPtrInput
	// The HTTP status code of the Gateway Response.
	StatusCode pulumi.StringPtrInput
}

func (ResponseState) ElementType added in v1.19.0 

func (ResponseState) ElementType() reflect.Type

type RestApi 

type RestApi struct {
	pulumi.CustomResourceState

	// The source of the API key for requests. Valid values are HEADER (default) and AUTHORIZER.
	ApiKeySource pulumi.StringPtrOutput `pulumi:"apiKeySource"`
	// Amazon Resource Name (ARN)
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
	BinaryMediaTypes pulumi.StringArrayOutput `pulumi:"binaryMediaTypes"`
	// An OpenAPI specification that defines the set of routes and integrations to create as part of the REST API.
	Body pulumi.StringPtrOutput `pulumi:"body"`
	// The creation date of the REST API
	CreatedDate pulumi.StringOutput `pulumi:"createdDate"`
	// The description of the REST API
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Nested argument defining API endpoint configuration including endpoint type. Defined below.
	EndpointConfiguration RestApiEndpointConfigurationOutput `pulumi:"endpointConfiguration"`
	// The execution ARN part to be used in [`lambdaPermission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn`
	// when allowing API Gateway to invoke a Lambda function,
	// e.g. `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j`, which can be concatenated with allowed stage, method and resource path.
	ExecutionArn pulumi.StringOutput `pulumi:"executionArn"`
	// Minimum response size to compress for the REST API. Integer between -1 and 10485760 (10MB). Setting a value greater than -1 will enable compression, -1 disables compression (default).
	MinimumCompressionSize pulumi.IntPtrOutput `pulumi:"minimumCompressionSize"`
	// The name of the REST API
	Name   pulumi.StringOutput    `pulumi:"name"`
	Policy pulumi.StringPtrOutput `pulumi:"policy"`
	// The resource ID of the REST API's root
	RootResourceId pulumi.StringOutput `pulumi:"rootResourceId"`
	// Key-value mapping of resource tags
	Tags pulumi.MapOutput `pulumi:"tags"`
}

Provides an API Gateway REST API.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_rest_api.html.markdown.

func GetRestApi 

func GetRestApi(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RestApiState, opts ...pulumi.ResourceOption) (*RestApi, error)

GetRestApi gets an existing RestApi resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRestApi 

func NewRestApi(ctx *pulumi.Context,
	name string, args *RestApiArgs, opts ...pulumi.ResourceOption) (*RestApi, error)

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

type RestApiArgs 

type RestApiArgs struct {
	// The source of the API key for requests. Valid values are HEADER (default) and AUTHORIZER.
	ApiKeySource pulumi.StringPtrInput
	// The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
	BinaryMediaTypes pulumi.StringArrayInput
	// An OpenAPI specification that defines the set of routes and integrations to create as part of the REST API.
	Body pulumi.StringPtrInput
	// The description of the REST API
	Description pulumi.StringPtrInput
	// Nested argument defining API endpoint configuration including endpoint type. Defined below.
	EndpointConfiguration RestApiEndpointConfigurationPtrInput
	// Minimum response size to compress for the REST API. Integer between -1 and 10485760 (10MB). Setting a value greater than -1 will enable compression, -1 disables compression (default).
	MinimumCompressionSize pulumi.IntPtrInput
	// The name of the REST API
	Name   pulumi.StringPtrInput
	Policy pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
}

The set of arguments for constructing a RestApi resource.

func (RestApiArgs) ElementType added in v1.19.0 

func (RestApiArgs) ElementType() reflect.Type

type RestApiEndpointConfiguration added in v1.19.0 

type RestApiEndpointConfiguration struct {
	// A list of endpoint types. This resource currently only supports managing a single value. Valid values: `EDGE`, `REGIONAL` or `PRIVATE`. If unspecified, defaults to `EDGE`. Must be declared as `REGIONAL` in non-Commercial partitions. Refer to the [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-regional-api.html) for more information on the difference between edge-optimized and regional APIs.
	Types string `pulumi:"types"`
	// A list of VPC Endpoint Ids. It is only supported for PRIVATE endpoint type.
	VpcEndpointIds []string `pulumi:"vpcEndpointIds"`
}

type RestApiEndpointConfigurationArgs added in v1.19.0 

type RestApiEndpointConfigurationArgs struct {
	// A list of endpoint types. This resource currently only supports managing a single value. Valid values: `EDGE`, `REGIONAL` or `PRIVATE`. If unspecified, defaults to `EDGE`. Must be declared as `REGIONAL` in non-Commercial partitions. Refer to the [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-regional-api.html) for more information on the difference between edge-optimized and regional APIs.
	Types pulumi.StringInput `pulumi:"types"`
	// A list of VPC Endpoint Ids. It is only supported for PRIVATE endpoint type.
	VpcEndpointIds pulumi.StringArrayInput `pulumi:"vpcEndpointIds"`
}

func (RestApiEndpointConfigurationArgs) ElementType added in v1.19.0 

func (RestApiEndpointConfigurationArgs) ElementType() reflect.Type

func (RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationOutput added in v1.19.0 

func (i RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationOutput() RestApiEndpointConfigurationOutput

func (RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationOutputWithContext added in v1.19.0 

func (i RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationOutputWithContext(ctx context.Context) RestApiEndpointConfigurationOutput

func (RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationPtrOutput added in v1.19.0 

func (i RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationPtrOutput() RestApiEndpointConfigurationPtrOutput

func (RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationPtrOutputWithContext added in v1.19.0 

func (i RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationPtrOutputWithContext(ctx context.Context) RestApiEndpointConfigurationPtrOutput

type RestApiEndpointConfigurationInput added in v1.19.0 

type RestApiEndpointConfigurationInput interface {
	pulumi.Input

	ToRestApiEndpointConfigurationOutput() RestApiEndpointConfigurationOutput
	ToRestApiEndpointConfigurationOutputWithContext(context.Context) RestApiEndpointConfigurationOutput
}

type RestApiEndpointConfigurationOutput added in v1.19.0 

type RestApiEndpointConfigurationOutput struct{ *pulumi.OutputState }

func (RestApiEndpointConfigurationOutput) ElementType added in v1.19.0 

func (RestApiEndpointConfigurationOutput) ElementType() reflect.Type

func (RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationOutput added in v1.19.0 

func (o RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationOutput() RestApiEndpointConfigurationOutput

func (RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationOutputWithContext added in v1.19.0 

func (o RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationOutputWithContext(ctx context.Context) RestApiEndpointConfigurationOutput

func (RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationPtrOutput added in v1.19.0 

func (o RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationPtrOutput() RestApiEndpointConfigurationPtrOutput

func (RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationPtrOutputWithContext added in v1.19.0 

func (o RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationPtrOutputWithContext(ctx context.Context) RestApiEndpointConfigurationPtrOutput

func (RestApiEndpointConfigurationOutput) Types added in v1.19.0 

func (o RestApiEndpointConfigurationOutput) Types() pulumi.StringOutput

A list of endpoint types. This resource currently only supports managing a single value. Valid values: `EDGE`, `REGIONAL` or `PRIVATE`. If unspecified, defaults to `EDGE`. Must be declared as `REGIONAL` in non-Commercial partitions. Refer to the [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-regional-api.html) for more information on the difference between edge-optimized and regional APIs.

func (RestApiEndpointConfigurationOutput) VpcEndpointIds added in v1.19.0 

func (o RestApiEndpointConfigurationOutput) VpcEndpointIds() pulumi.StringArrayOutput

A list of VPC Endpoint Ids. It is only supported for PRIVATE endpoint type.

type RestApiEndpointConfigurationPtrInput added in v1.19.0 

type RestApiEndpointConfigurationPtrInput interface {
	pulumi.Input

	ToRestApiEndpointConfigurationPtrOutput() RestApiEndpointConfigurationPtrOutput
	ToRestApiEndpointConfigurationPtrOutputWithContext(context.Context) RestApiEndpointConfigurationPtrOutput
}

func RestApiEndpointConfigurationPtr added in v1.19.0 

func RestApiEndpointConfigurationPtr(v *RestApiEndpointConfigurationArgs) RestApiEndpointConfigurationPtrInput

type RestApiEndpointConfigurationPtrOutput added in v1.19.0 

type RestApiEndpointConfigurationPtrOutput struct{ *pulumi.OutputState }

func (RestApiEndpointConfigurationPtrOutput) Elem added in v1.19.0 

func (o RestApiEndpointConfigurationPtrOutput) Elem() RestApiEndpointConfigurationOutput

func (RestApiEndpointConfigurationPtrOutput) ElementType added in v1.19.0 

func (RestApiEndpointConfigurationPtrOutput) ElementType() reflect.Type

func (RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutput added in v1.19.0 

func (o RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutput() RestApiEndpointConfigurationPtrOutput

func (RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutputWithContext added in v1.19.0 

func (o RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutputWithContext(ctx context.Context) RestApiEndpointConfigurationPtrOutput

func (RestApiEndpointConfigurationPtrOutput) Types added in v1.19.0 

func (o RestApiEndpointConfigurationPtrOutput) Types() pulumi.StringOutput

A list of endpoint types. This resource currently only supports managing a single value. Valid values: `EDGE`, `REGIONAL` or `PRIVATE`. If unspecified, defaults to `EDGE`. Must be declared as `REGIONAL` in non-Commercial partitions. Refer to the [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-regional-api.html) for more information on the difference between edge-optimized and regional APIs.

func (RestApiEndpointConfigurationPtrOutput) VpcEndpointIds added in v1.19.0 

func (o RestApiEndpointConfigurationPtrOutput) VpcEndpointIds() pulumi.StringArrayOutput

A list of VPC Endpoint Ids. It is only supported for PRIVATE endpoint type.

type RestApiState 

type RestApiState struct {
	// The source of the API key for requests. Valid values are HEADER (default) and AUTHORIZER.
	ApiKeySource pulumi.StringPtrInput
	// Amazon Resource Name (ARN)
	Arn pulumi.StringPtrInput
	// The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
	BinaryMediaTypes pulumi.StringArrayInput
	// An OpenAPI specification that defines the set of routes and integrations to create as part of the REST API.
	Body pulumi.StringPtrInput
	// The creation date of the REST API
	CreatedDate pulumi.StringPtrInput
	// The description of the REST API
	Description pulumi.StringPtrInput
	// Nested argument defining API endpoint configuration including endpoint type. Defined below.
	EndpointConfiguration RestApiEndpointConfigurationPtrInput
	// The execution ARN part to be used in [`lambdaPermission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn`
	// when allowing API Gateway to invoke a Lambda function,
	// e.g. `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j`, which can be concatenated with allowed stage, method and resource path.
	ExecutionArn pulumi.StringPtrInput
	// Minimum response size to compress for the REST API. Integer between -1 and 10485760 (10MB). Setting a value greater than -1 will enable compression, -1 disables compression (default).
	MinimumCompressionSize pulumi.IntPtrInput
	// The name of the REST API
	Name   pulumi.StringPtrInput
	Policy pulumi.StringPtrInput
	// The resource ID of the REST API's root
	RootResourceId pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
}

func (RestApiState) ElementType added in v1.19.0 

func (RestApiState) ElementType() reflect.Type

type Stage 

type Stage struct {
	pulumi.CustomResourceState

	// Enables access logs for the API stage. Detailed below.
	AccessLogSettings StageAccessLogSettingsPtrOutput `pulumi:"accessLogSettings"`
	// Amazon Resource Name (ARN)
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Specifies whether a cache cluster is enabled for the stage
	CacheClusterEnabled pulumi.BoolPtrOutput `pulumi:"cacheClusterEnabled"`
	// The size of the cache cluster for the stage, if enabled.
	// Allowed values include `0.5`, `1.6`, `6.1`, `13.5`, `28.4`, `58.2`, `118` and `237`.
	CacheClusterSize pulumi.StringPtrOutput `pulumi:"cacheClusterSize"`
	// The identifier of a client certificate for the stage.
	ClientCertificateId pulumi.StringPtrOutput `pulumi:"clientCertificateId"`
	// The ID of the deployment that the stage points to
	Deployment pulumi.StringOutput `pulumi:"deployment"`
	// The description of the stage
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The version of the associated API documentation
	DocumentationVersion pulumi.StringPtrOutput `pulumi:"documentationVersion"`
	// The execution ARN to be used in [`lambdaPermission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn`
	// when allowing API Gateway to invoke a Lambda function,
	// e.g. `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod`
	ExecutionArn pulumi.StringOutput `pulumi:"executionArn"`
	// The URL to invoke the API pointing to the stage,
	// e.g. `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod`
	InvokeUrl pulumi.StringOutput `pulumi:"invokeUrl"`
	// The ID of the associated REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
	// The name of the stage
	StageName pulumi.StringOutput `pulumi:"stageName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapOutput `pulumi:"tags"`
	// A map that defines the stage variables
	Variables pulumi.MapOutput `pulumi:"variables"`
	// Whether active tracing with X-ray is enabled. Defaults to `false`.
	XrayTracingEnabled pulumi.BoolPtrOutput `pulumi:"xrayTracingEnabled"`
}

Provides an API Gateway Stage.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_stage.html.markdown.

func GetStage 

func GetStage(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *StageState, opts ...pulumi.ResourceOption) (*Stage, error)

GetStage gets an existing Stage resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewStage 

func NewStage(ctx *pulumi.Context,
	name string, args *StageArgs, opts ...pulumi.ResourceOption) (*Stage, error)

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

type StageAccessLogSettings added in v1.19.0 

type StageAccessLogSettings struct {
	// The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-`. Automatically removes trailing `:*` if present.
	DestinationArn string `pulumi:"destinationArn"`
	// The formatting and values recorded in the logs.
	// For more information on configuring the log format rules visit the AWS [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html)
	Format string `pulumi:"format"`
}

type StageAccessLogSettingsArgs added in v1.19.0 

type StageAccessLogSettingsArgs struct {
	// The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-`. Automatically removes trailing `:*` if present.
	DestinationArn pulumi.StringInput `pulumi:"destinationArn"`
	// The formatting and values recorded in the logs.
	// For more information on configuring the log format rules visit the AWS [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html)
	Format pulumi.StringInput `pulumi:"format"`
}

func (StageAccessLogSettingsArgs) ElementType added in v1.19.0 

func (StageAccessLogSettingsArgs) ElementType() reflect.Type

func (StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutput added in v1.19.0 

func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutput() StageAccessLogSettingsOutput

func (StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutputWithContext added in v1.19.0 

func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutputWithContext(ctx context.Context) StageAccessLogSettingsOutput

func (StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutput added in v1.19.0 

func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput

func (StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutputWithContext added in v1.19.0 

func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutputWithContext(ctx context.Context) StageAccessLogSettingsPtrOutput

type StageAccessLogSettingsInput added in v1.19.0 

type StageAccessLogSettingsInput interface {
	pulumi.Input

	ToStageAccessLogSettingsOutput() StageAccessLogSettingsOutput
	ToStageAccessLogSettingsOutputWithContext(context.Context) StageAccessLogSettingsOutput
}

type StageAccessLogSettingsOutput added in v1.19.0 

type StageAccessLogSettingsOutput struct{ *pulumi.OutputState }

func (StageAccessLogSettingsOutput) DestinationArn added in v1.19.0 

func (o StageAccessLogSettingsOutput) DestinationArn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-`. Automatically removes trailing `:*` if present.

func (StageAccessLogSettingsOutput) ElementType added in v1.19.0 

func (StageAccessLogSettingsOutput) ElementType() reflect.Type

func (StageAccessLogSettingsOutput) Format added in v1.19.0 

func (o StageAccessLogSettingsOutput) Format() pulumi.StringOutput

The formatting and values recorded in the logs. For more information on configuring the log format rules visit the AWS [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html)

func (StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutput added in v1.19.0 

func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutput() StageAccessLogSettingsOutput

func (StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutputWithContext added in v1.19.0 

func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutputWithContext(ctx context.Context) StageAccessLogSettingsOutput

func (StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutput added in v1.19.0 

func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput

func (StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutputWithContext added in v1.19.0 

func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutputWithContext(ctx context.Context) StageAccessLogSettingsPtrOutput

type StageAccessLogSettingsPtrInput added in v1.19.0 

type StageAccessLogSettingsPtrInput interface {
	pulumi.Input

	ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput
	ToStageAccessLogSettingsPtrOutputWithContext(context.Context) StageAccessLogSettingsPtrOutput
}

func StageAccessLogSettingsPtr added in v1.19.0 

func StageAccessLogSettingsPtr(v *StageAccessLogSettingsArgs) StageAccessLogSettingsPtrInput

type StageAccessLogSettingsPtrOutput added in v1.19.0 

type StageAccessLogSettingsPtrOutput struct{ *pulumi.OutputState }

func (StageAccessLogSettingsPtrOutput) DestinationArn added in v1.19.0 

func (o StageAccessLogSettingsPtrOutput) DestinationArn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-`. Automatically removes trailing `:*` if present.

func (StageAccessLogSettingsPtrOutput) Elem added in v1.19.0 

func (o StageAccessLogSettingsPtrOutput) Elem() StageAccessLogSettingsOutput

func (StageAccessLogSettingsPtrOutput) ElementType added in v1.19.0 

func (StageAccessLogSettingsPtrOutput) ElementType() reflect.Type

func (StageAccessLogSettingsPtrOutput) Format added in v1.19.0 

func (o StageAccessLogSettingsPtrOutput) Format() pulumi.StringOutput

The formatting and values recorded in the logs. For more information on configuring the log format rules visit the AWS [documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html)

func (StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutput added in v1.19.0 

func (o StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput

func (StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutputWithContext added in v1.19.0 

func (o StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutputWithContext(ctx context.Context) StageAccessLogSettingsPtrOutput

type StageArgs 

type StageArgs struct {
	// Enables access logs for the API stage. Detailed below.
	AccessLogSettings StageAccessLogSettingsPtrInput
	// Specifies whether a cache cluster is enabled for the stage
	CacheClusterEnabled pulumi.BoolPtrInput
	// The size of the cache cluster for the stage, if enabled.
	// Allowed values include `0.5`, `1.6`, `6.1`, `13.5`, `28.4`, `58.2`, `118` and `237`.
	CacheClusterSize pulumi.StringPtrInput
	// The identifier of a client certificate for the stage.
	ClientCertificateId pulumi.StringPtrInput
	// The ID of the deployment that the stage points to
	Deployment pulumi.StringInput
	// The description of the stage
	Description pulumi.StringPtrInput
	// The version of the associated API documentation
	DocumentationVersion pulumi.StringPtrInput
	// The ID of the associated REST API
	RestApi pulumi.StringInput
	// The name of the stage
	StageName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapInput
	// A map that defines the stage variables
	Variables pulumi.MapInput
	// Whether active tracing with X-ray is enabled. Defaults to `false`.
	XrayTracingEnabled pulumi.BoolPtrInput
}

The set of arguments for constructing a Stage resource.

func (StageArgs) ElementType added in v1.19.0 

func (StageArgs) ElementType() reflect.Type

type StageState 

type StageState struct {
	// Enables access logs for the API stage. Detailed below.
	AccessLogSettings StageAccessLogSettingsPtrInput
	// Amazon Resource Name (ARN)
	Arn pulumi.StringPtrInput
	// Specifies whether a cache cluster is enabled for the stage
	CacheClusterEnabled pulumi.BoolPtrInput
	// The size of the cache cluster for the stage, if enabled.
	// Allowed values include `0.5`, `1.6`, `6.1`, `13.5`, `28.4`, `58.2`, `118` and `237`.
	CacheClusterSize pulumi.StringPtrInput
	// The identifier of a client certificate for the stage.
	ClientCertificateId pulumi.StringPtrInput
	// The ID of the deployment that the stage points to
	Deployment pulumi.StringPtrInput
	// The description of the stage
	Description pulumi.StringPtrInput
	// The version of the associated API documentation
	DocumentationVersion pulumi.StringPtrInput
	// The execution ARN to be used in [`lambdaPermission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn`
	// when allowing API Gateway to invoke a Lambda function,
	// e.g. `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod`
	ExecutionArn pulumi.StringPtrInput
	// The URL to invoke the API pointing to the stage,
	// e.g. `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod`
	InvokeUrl pulumi.StringPtrInput
	// The ID of the associated REST API
	RestApi pulumi.StringPtrInput
	// The name of the stage
	StageName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapInput
	// A map that defines the stage variables
	Variables pulumi.MapInput
	// Whether active tracing with X-ray is enabled. Defaults to `false`.
	XrayTracingEnabled pulumi.BoolPtrInput
}

func (StageState) ElementType added in v1.19.0 

func (StageState) ElementType() reflect.Type

type UsagePlan 

type UsagePlan struct {
	pulumi.CustomResourceState

	// The associated API stages of the usage plan.
	ApiStages UsagePlanApiStageArrayOutput `pulumi:"apiStages"`
	// Amazon Resource Name (ARN)
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The description of a usage plan.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the usage plan.
	Name pulumi.StringOutput `pulumi:"name"`
	// The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
	ProductCode pulumi.StringPtrOutput `pulumi:"productCode"`
	// The quota settings of the usage plan.
	QuotaSettings UsagePlanQuotaSettingsPtrOutput `pulumi:"quotaSettings"`
	// Key-value mapping of resource tags
	Tags pulumi.MapOutput `pulumi:"tags"`
	// The throttling limits of the usage plan.
	ThrottleSettings UsagePlanThrottleSettingsPtrOutput `pulumi:"throttleSettings"`
}

Provides an API Gateway Usage Plan.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_usage_plan.html.markdown.

func GetUsagePlan 

func GetUsagePlan(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UsagePlanState, opts ...pulumi.ResourceOption) (*UsagePlan, error)

GetUsagePlan gets an existing UsagePlan resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUsagePlan 

func NewUsagePlan(ctx *pulumi.Context,
	name string, args *UsagePlanArgs, opts ...pulumi.ResourceOption) (*UsagePlan, error)

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

type UsagePlanApiStage added in v1.19.0 

type UsagePlanApiStage struct {
	// API Id of the associated API stage in a usage plan.
	ApiId string `pulumi:"apiId"`
	// API stage name of the associated API stage in a usage plan.
	Stage string `pulumi:"stage"`
}

type UsagePlanApiStageArgs added in v1.19.0 

type UsagePlanApiStageArgs struct {
	// API Id of the associated API stage in a usage plan.
	ApiId pulumi.StringInput `pulumi:"apiId"`
	// API stage name of the associated API stage in a usage plan.
	Stage pulumi.StringInput `pulumi:"stage"`
}

func (UsagePlanApiStageArgs) ElementType added in v1.19.0 

func (UsagePlanApiStageArgs) ElementType() reflect.Type

func (UsagePlanApiStageArgs) ToUsagePlanApiStageOutput added in v1.19.0 

func (i UsagePlanApiStageArgs) ToUsagePlanApiStageOutput() UsagePlanApiStageOutput

func (UsagePlanApiStageArgs) ToUsagePlanApiStageOutputWithContext added in v1.19.0 

func (i UsagePlanApiStageArgs) ToUsagePlanApiStageOutputWithContext(ctx context.Context) UsagePlanApiStageOutput

type UsagePlanApiStageArray added in v1.19.0 

type UsagePlanApiStageArray []UsagePlanApiStageInput

func (UsagePlanApiStageArray) ElementType added in v1.19.0 

func (UsagePlanApiStageArray) ElementType() reflect.Type

func (UsagePlanApiStageArray) ToUsagePlanApiStageArrayOutput added in v1.19.0 

func (i UsagePlanApiStageArray) ToUsagePlanApiStageArrayOutput() UsagePlanApiStageArrayOutput

func (UsagePlanApiStageArray) ToUsagePlanApiStageArrayOutputWithContext added in v1.19.0 

func (i UsagePlanApiStageArray) ToUsagePlanApiStageArrayOutputWithContext(ctx context.Context) UsagePlanApiStageArrayOutput

type UsagePlanApiStageArrayInput added in v1.19.0 

type UsagePlanApiStageArrayInput interface {
	pulumi.Input

	ToUsagePlanApiStageArrayOutput() UsagePlanApiStageArrayOutput
	ToUsagePlanApiStageArrayOutputWithContext(context.Context) UsagePlanApiStageArrayOutput
}

type UsagePlanApiStageArrayOutput added in v1.19.0 

type UsagePlanApiStageArrayOutput struct{ *pulumi.OutputState }

func (UsagePlanApiStageArrayOutput) ElementType added in v1.19.0 

func (UsagePlanApiStageArrayOutput) ElementType() reflect.Type

func (UsagePlanApiStageArrayOutput) Index added in v1.19.0 

func (o UsagePlanApiStageArrayOutput) Index(i pulumi.IntInput) UsagePlanApiStageOutput

func (UsagePlanApiStageArrayOutput) ToUsagePlanApiStageArrayOutput added in v1.19.0 

func (o UsagePlanApiStageArrayOutput) ToUsagePlanApiStageArrayOutput() UsagePlanApiStageArrayOutput

func (UsagePlanApiStageArrayOutput) ToUsagePlanApiStageArrayOutputWithContext added in v1.19.0 

func (o UsagePlanApiStageArrayOutput) ToUsagePlanApiStageArrayOutputWithContext(ctx context.Context) UsagePlanApiStageArrayOutput

type UsagePlanApiStageInput added in v1.19.0 

type UsagePlanApiStageInput interface {
	pulumi.Input

	ToUsagePlanApiStageOutput() UsagePlanApiStageOutput
	ToUsagePlanApiStageOutputWithContext(context.Context) UsagePlanApiStageOutput
}

type UsagePlanApiStageOutput added in v1.19.0 

type UsagePlanApiStageOutput struct{ *pulumi.OutputState }

func (UsagePlanApiStageOutput) ApiId added in v1.19.0 

func (o UsagePlanApiStageOutput) ApiId() pulumi.StringOutput

API Id of the associated API stage in a usage plan.

func (UsagePlanApiStageOutput) ElementType added in v1.19.0 

func (UsagePlanApiStageOutput) ElementType() reflect.Type

func (UsagePlanApiStageOutput) Stage added in v1.19.0 

func (o UsagePlanApiStageOutput) Stage() pulumi.StringOutput

API stage name of the associated API stage in a usage plan.

func (UsagePlanApiStageOutput) ToUsagePlanApiStageOutput added in v1.19.0 

func (o UsagePlanApiStageOutput) ToUsagePlanApiStageOutput() UsagePlanApiStageOutput

func (UsagePlanApiStageOutput) ToUsagePlanApiStageOutputWithContext added in v1.19.0 

func (o UsagePlanApiStageOutput) ToUsagePlanApiStageOutputWithContext(ctx context.Context) UsagePlanApiStageOutput

type UsagePlanArgs 

type UsagePlanArgs struct {
	// The associated API stages of the usage plan.
	ApiStages UsagePlanApiStageArrayInput
	// The description of a usage plan.
	Description pulumi.StringPtrInput
	// The name of the usage plan.
	Name pulumi.StringPtrInput
	// The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
	ProductCode pulumi.StringPtrInput
	// The quota settings of the usage plan.
	QuotaSettings UsagePlanQuotaSettingsPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
	// The throttling limits of the usage plan.
	ThrottleSettings UsagePlanThrottleSettingsPtrInput
}

The set of arguments for constructing a UsagePlan resource.

func (UsagePlanArgs) ElementType added in v1.19.0 

func (UsagePlanArgs) ElementType() reflect.Type

type UsagePlanKey 

type UsagePlanKey struct {
	pulumi.CustomResourceState

	// The identifier of the API key resource.
	KeyId pulumi.StringOutput `pulumi:"keyId"`
	// The type of the API key resource. Currently, the valid key type is API_KEY.
	KeyType pulumi.StringOutput `pulumi:"keyType"`
	// The name of a usage plan key.
	Name pulumi.StringOutput `pulumi:"name"`
	// The Id of the usage plan resource representing to associate the key to.
	UsagePlanId pulumi.StringOutput `pulumi:"usagePlanId"`
	// The value of a usage plan key.
	Value pulumi.StringOutput `pulumi:"value"`
}

Provides an API Gateway Usage Plan Key.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_usage_plan_key.html.markdown.

func GetUsagePlanKey 

func GetUsagePlanKey(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UsagePlanKeyState, opts ...pulumi.ResourceOption) (*UsagePlanKey, error)

GetUsagePlanKey gets an existing UsagePlanKey resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUsagePlanKey 

func NewUsagePlanKey(ctx *pulumi.Context,
	name string, args *UsagePlanKeyArgs, opts ...pulumi.ResourceOption) (*UsagePlanKey, error)

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

type UsagePlanKeyArgs 

type UsagePlanKeyArgs struct {
	// The identifier of the API key resource.
	KeyId pulumi.StringInput
	// The type of the API key resource. Currently, the valid key type is API_KEY.
	KeyType pulumi.StringInput
	// The Id of the usage plan resource representing to associate the key to.
	UsagePlanId pulumi.StringInput
}

The set of arguments for constructing a UsagePlanKey resource.

func (UsagePlanKeyArgs) ElementType added in v1.19.0 

func (UsagePlanKeyArgs) ElementType() reflect.Type

type UsagePlanKeyState 

type UsagePlanKeyState struct {
	// The identifier of the API key resource.
	KeyId pulumi.StringPtrInput
	// The type of the API key resource. Currently, the valid key type is API_KEY.
	KeyType pulumi.StringPtrInput
	// The name of a usage plan key.
	Name pulumi.StringPtrInput
	// The Id of the usage plan resource representing to associate the key to.
	UsagePlanId pulumi.StringPtrInput
	// The value of a usage plan key.
	Value pulumi.StringPtrInput
}

func (UsagePlanKeyState) ElementType added in v1.19.0 

func (UsagePlanKeyState) ElementType() reflect.Type

type UsagePlanQuotaSettings added in v1.19.0 

type UsagePlanQuotaSettings struct {
	// The maximum number of requests that can be made in a given time period.
	Limit int `pulumi:"limit"`
	// The number of requests subtracted from the given limit in the initial time period.
	Offset *int `pulumi:"offset"`
	// The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
	Period string `pulumi:"period"`
}

type UsagePlanQuotaSettingsArgs added in v1.19.0 

type UsagePlanQuotaSettingsArgs struct {
	// The maximum number of requests that can be made in a given time period.
	Limit pulumi.IntInput `pulumi:"limit"`
	// The number of requests subtracted from the given limit in the initial time period.
	Offset pulumi.IntPtrInput `pulumi:"offset"`
	// The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
	Period pulumi.StringInput `pulumi:"period"`
}

func (UsagePlanQuotaSettingsArgs) ElementType added in v1.19.0 

func (UsagePlanQuotaSettingsArgs) ElementType() reflect.Type

func (UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsOutput added in v1.19.0 

func (i UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsOutput() UsagePlanQuotaSettingsOutput

func (UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsOutputWithContext added in v1.19.0 

func (i UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsOutputWithContext(ctx context.Context) UsagePlanQuotaSettingsOutput

func (UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsPtrOutput added in v1.19.0 

func (i UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsPtrOutput() UsagePlanQuotaSettingsPtrOutput

func (UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsPtrOutputWithContext added in v1.19.0 

func (i UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsPtrOutputWithContext(ctx context.Context) UsagePlanQuotaSettingsPtrOutput

type UsagePlanQuotaSettingsInput added in v1.19.0 

type UsagePlanQuotaSettingsInput interface {
	pulumi.Input

	ToUsagePlanQuotaSettingsOutput() UsagePlanQuotaSettingsOutput
	ToUsagePlanQuotaSettingsOutputWithContext(context.Context) UsagePlanQuotaSettingsOutput
}

type UsagePlanQuotaSettingsOutput added in v1.19.0 

type UsagePlanQuotaSettingsOutput struct{ *pulumi.OutputState }

func (UsagePlanQuotaSettingsOutput) ElementType added in v1.19.0 

func (UsagePlanQuotaSettingsOutput) ElementType() reflect.Type

func (UsagePlanQuotaSettingsOutput) Limit added in v1.19.0 

func (o UsagePlanQuotaSettingsOutput) Limit() pulumi.IntOutput

The maximum number of requests that can be made in a given time period.

func (UsagePlanQuotaSettingsOutput) Offset added in v1.19.0 

func (o UsagePlanQuotaSettingsOutput) Offset() pulumi.IntPtrOutput

The number of requests subtracted from the given limit in the initial time period.

func (UsagePlanQuotaSettingsOutput) Period added in v1.19.0 

func (o UsagePlanQuotaSettingsOutput) Period() pulumi.StringOutput

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

func (UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsOutput added in v1.19.0 

func (o UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsOutput() UsagePlanQuotaSettingsOutput

func (UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsOutputWithContext added in v1.19.0 

func (o UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsOutputWithContext(ctx context.Context) UsagePlanQuotaSettingsOutput

func (UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsPtrOutput added in v1.19.0 

func (o UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsPtrOutput() UsagePlanQuotaSettingsPtrOutput

func (UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsPtrOutputWithContext added in v1.19.0 

func (o UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsPtrOutputWithContext(ctx context.Context) UsagePlanQuotaSettingsPtrOutput

type UsagePlanQuotaSettingsPtrInput added in v1.19.0 

type UsagePlanQuotaSettingsPtrInput interface {
	pulumi.Input

	ToUsagePlanQuotaSettingsPtrOutput() UsagePlanQuotaSettingsPtrOutput
	ToUsagePlanQuotaSettingsPtrOutputWithContext(context.Context) UsagePlanQuotaSettingsPtrOutput
}

func UsagePlanQuotaSettingsPtr added in v1.19.0 

func UsagePlanQuotaSettingsPtr(v *UsagePlanQuotaSettingsArgs) UsagePlanQuotaSettingsPtrInput

type UsagePlanQuotaSettingsPtrOutput added in v1.19.0 

type UsagePlanQuotaSettingsPtrOutput struct{ *pulumi.OutputState }

func (UsagePlanQuotaSettingsPtrOutput) Elem added in v1.19.0 

func (o UsagePlanQuotaSettingsPtrOutput) Elem() UsagePlanQuotaSettingsOutput

func (UsagePlanQuotaSettingsPtrOutput) ElementType added in v1.19.0 

func (UsagePlanQuotaSettingsPtrOutput) ElementType() reflect.Type

func (UsagePlanQuotaSettingsPtrOutput) Limit added in v1.19.0 

func (o UsagePlanQuotaSettingsPtrOutput) Limit() pulumi.IntOutput

The maximum number of requests that can be made in a given time period.

func (UsagePlanQuotaSettingsPtrOutput) Offset added in v1.19.0 

func (o UsagePlanQuotaSettingsPtrOutput) Offset() pulumi.IntPtrOutput

The number of requests subtracted from the given limit in the initial time period.

func (UsagePlanQuotaSettingsPtrOutput) Period added in v1.19.0 

func (o UsagePlanQuotaSettingsPtrOutput) Period() pulumi.StringOutput

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

func (UsagePlanQuotaSettingsPtrOutput) ToUsagePlanQuotaSettingsPtrOutput added in v1.19.0 

func (o UsagePlanQuotaSettingsPtrOutput) ToUsagePlanQuotaSettingsPtrOutput() UsagePlanQuotaSettingsPtrOutput

func (UsagePlanQuotaSettingsPtrOutput) ToUsagePlanQuotaSettingsPtrOutputWithContext added in v1.19.0 

func (o UsagePlanQuotaSettingsPtrOutput) ToUsagePlanQuotaSettingsPtrOutputWithContext(ctx context.Context) UsagePlanQuotaSettingsPtrOutput

type UsagePlanState 

type UsagePlanState struct {
	// The associated API stages of the usage plan.
	ApiStages UsagePlanApiStageArrayInput
	// Amazon Resource Name (ARN)
	Arn pulumi.StringPtrInput
	// The description of a usage plan.
	Description pulumi.StringPtrInput
	// The name of the usage plan.
	Name pulumi.StringPtrInput
	// The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
	ProductCode pulumi.StringPtrInput
	// The quota settings of the usage plan.
	QuotaSettings UsagePlanQuotaSettingsPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
	// The throttling limits of the usage plan.
	ThrottleSettings UsagePlanThrottleSettingsPtrInput
}

func (UsagePlanState) ElementType added in v1.19.0 

func (UsagePlanState) ElementType() reflect.Type

type UsagePlanThrottleSettings added in v1.19.0 

type UsagePlanThrottleSettings struct {
	// The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
	BurstLimit *int `pulumi:"burstLimit"`
	// The API request steady-state rate limit.
	RateLimit *float64 `pulumi:"rateLimit"`
}

type UsagePlanThrottleSettingsArgs added in v1.19.0 

type UsagePlanThrottleSettingsArgs struct {
	// The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
	BurstLimit pulumi.IntPtrInput `pulumi:"burstLimit"`
	// The API request steady-state rate limit.
	RateLimit pulumi.Float64PtrInput `pulumi:"rateLimit"`
}

func (UsagePlanThrottleSettingsArgs) ElementType added in v1.19.0 

func (UsagePlanThrottleSettingsArgs) ElementType() reflect.Type

func (UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsOutput added in v1.19.0 

func (i UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsOutput() UsagePlanThrottleSettingsOutput

func (UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsOutputWithContext added in v1.19.0 

func (i UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsOutputWithContext(ctx context.Context) UsagePlanThrottleSettingsOutput

func (UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsPtrOutput added in v1.19.0 

func (i UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsPtrOutput() UsagePlanThrottleSettingsPtrOutput

func (UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsPtrOutputWithContext added in v1.19.0 

func (i UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsPtrOutputWithContext(ctx context.Context) UsagePlanThrottleSettingsPtrOutput

type UsagePlanThrottleSettingsInput added in v1.19.0 

type UsagePlanThrottleSettingsInput interface {
	pulumi.Input

	ToUsagePlanThrottleSettingsOutput() UsagePlanThrottleSettingsOutput
	ToUsagePlanThrottleSettingsOutputWithContext(context.Context) UsagePlanThrottleSettingsOutput
}

type UsagePlanThrottleSettingsOutput added in v1.19.0 

type UsagePlanThrottleSettingsOutput struct{ *pulumi.OutputState }

func (UsagePlanThrottleSettingsOutput) BurstLimit added in v1.19.0 

func (o UsagePlanThrottleSettingsOutput) BurstLimit() pulumi.IntPtrOutput

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

func (UsagePlanThrottleSettingsOutput) ElementType added in v1.19.0 

func (UsagePlanThrottleSettingsOutput) ElementType() reflect.Type

func (UsagePlanThrottleSettingsOutput) RateLimit added in v1.19.0 

func (o UsagePlanThrottleSettingsOutput) RateLimit() pulumi.Float64PtrOutput

The API request steady-state rate limit.

func (UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsOutput added in v1.19.0 

func (o UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsOutput() UsagePlanThrottleSettingsOutput

func (UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsOutputWithContext added in v1.19.0 

func (o UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsOutputWithContext(ctx context.Context) UsagePlanThrottleSettingsOutput

func (UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsPtrOutput added in v1.19.0 

func (o UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsPtrOutput() UsagePlanThrottleSettingsPtrOutput

func (UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsPtrOutputWithContext added in v1.19.0 

func (o UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsPtrOutputWithContext(ctx context.Context) UsagePlanThrottleSettingsPtrOutput

type UsagePlanThrottleSettingsPtrInput added in v1.19.0 

type UsagePlanThrottleSettingsPtrInput interface {
	pulumi.Input

	ToUsagePlanThrottleSettingsPtrOutput() UsagePlanThrottleSettingsPtrOutput
	ToUsagePlanThrottleSettingsPtrOutputWithContext(context.Context) UsagePlanThrottleSettingsPtrOutput
}

func UsagePlanThrottleSettingsPtr added in v1.19.0 

func UsagePlanThrottleSettingsPtr(v *UsagePlanThrottleSettingsArgs) UsagePlanThrottleSettingsPtrInput

type UsagePlanThrottleSettingsPtrOutput added in v1.19.0 

type UsagePlanThrottleSettingsPtrOutput struct{ *pulumi.OutputState }

func (UsagePlanThrottleSettingsPtrOutput) BurstLimit added in v1.19.0 

func (o UsagePlanThrottleSettingsPtrOutput) BurstLimit() pulumi.IntPtrOutput

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

func (UsagePlanThrottleSettingsPtrOutput) Elem added in v1.19.0 

func (o UsagePlanThrottleSettingsPtrOutput) Elem() UsagePlanThrottleSettingsOutput

func (UsagePlanThrottleSettingsPtrOutput) ElementType added in v1.19.0 

func (UsagePlanThrottleSettingsPtrOutput) ElementType() reflect.Type

func (UsagePlanThrottleSettingsPtrOutput) RateLimit added in v1.19.0 

func (o UsagePlanThrottleSettingsPtrOutput) RateLimit() pulumi.Float64PtrOutput

The API request steady-state rate limit.

func (UsagePlanThrottleSettingsPtrOutput) ToUsagePlanThrottleSettingsPtrOutput added in v1.19.0 

func (o UsagePlanThrottleSettingsPtrOutput) ToUsagePlanThrottleSettingsPtrOutput() UsagePlanThrottleSettingsPtrOutput

func (UsagePlanThrottleSettingsPtrOutput) ToUsagePlanThrottleSettingsPtrOutputWithContext added in v1.19.0 

func (o UsagePlanThrottleSettingsPtrOutput) ToUsagePlanThrottleSettingsPtrOutputWithContext(ctx context.Context) UsagePlanThrottleSettingsPtrOutput
type VpcLink struct {
	pulumi.CustomResourceState

	Arn pulumi.StringOutput `pulumi:"arn"`
	// The description of the VPC link.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name used to label and identify the VPC link.
	Name pulumi.StringOutput `pulumi:"name"`
	// Key-value mapping of resource tags
	Tags pulumi.MapOutput `pulumi:"tags"`
	// The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
	TargetArn pulumi.StringOutput `pulumi:"targetArn"`
}

Provides an API Gateway VPC Link.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/api_gateway_vpc_link.html.markdown. 

func GetVpcLink(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *VpcLinkState, opts ...pulumi.ResourceOption) (*VpcLink, error)

GetVpcLink gets an existing VpcLink resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required). 

func NewVpcLink(ctx *pulumi.Context,
	name string, args *VpcLinkArgs, opts ...pulumi.ResourceOption) (*VpcLink, error)

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

type VpcLinkArgs 

type VpcLinkArgs struct {
	// The description of the VPC link.
	Description pulumi.StringPtrInput
	// The name used to label and identify the VPC link.
	Name pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
	// The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
	TargetArn pulumi.StringInput
}

The set of arguments for constructing a VpcLink resource.

func (VpcLinkArgs) ElementType added in v1.19.0 

func (VpcLinkArgs) ElementType() reflect.Type

type VpcLinkState 

type VpcLinkState struct {
	Arn pulumi.StringPtrInput
	// The description of the VPC link.
	Description pulumi.StringPtrInput
	// The name used to label and identify the VPC link.
	Name pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.MapInput
	// The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
	TargetArn pulumi.StringPtrInput
}

func (VpcLinkState) ElementType added in v1.19.0 

func (VpcLinkState) ElementType() reflect.Type

Source Files

View all Source files

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.