apigateway

package
v0.104.0 Latest Latest
Warning

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

 Go to latest Published: Apr 30, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DocumentationPartLocationTypeApi            = DocumentationPartLocationType("API")
	DocumentationPartLocationTypeAuthorizer     = DocumentationPartLocationType("AUTHORIZER")
	DocumentationPartLocationTypeModel          = DocumentationPartLocationType("MODEL")
	DocumentationPartLocationTypeResource       = DocumentationPartLocationType("RESOURCE")
	DocumentationPartLocationTypeMethod         = DocumentationPartLocationType("METHOD")
	DocumentationPartLocationTypePathParameter  = DocumentationPartLocationType("PATH_PARAMETER")
	DocumentationPartLocationTypeQueryParameter = DocumentationPartLocationType("QUERY_PARAMETER")
	DocumentationPartLocationTypeRequestHeader  = DocumentationPartLocationType("REQUEST_HEADER")
	DocumentationPartLocationTypeRequestBody    = DocumentationPartLocationType("REQUEST_BODY")
	DocumentationPartLocationTypeResponse       = DocumentationPartLocationType("RESPONSE")
	DocumentationPartLocationTypeResponseHeader = DocumentationPartLocationType("RESPONSE_HEADER")
	DocumentationPartLocationTypeResponseBody   = DocumentationPartLocationType("RESPONSE_BODY")
)
View Source 
const (
	MethodAuthorizationTypeNone             = MethodAuthorizationType("NONE")
	MethodAuthorizationTypeAwsIam           = MethodAuthorizationType("AWS_IAM")
	MethodAuthorizationTypeCustom           = MethodAuthorizationType("CUSTOM")
	MethodAuthorizationTypeCognitoUserPools = MethodAuthorizationType("COGNITO_USER_POOLS")
)
View Source 
const (
	MethodIntegrationConnectionTypeInternet = MethodIntegrationConnectionType("INTERNET")
	MethodIntegrationConnectionTypeVpcLink  = MethodIntegrationConnectionType("VPC_LINK")
)
View Source 
const (
	MethodIntegrationContentHandlingConvertToBinary = MethodIntegrationContentHandling("CONVERT_TO_BINARY")
	MethodIntegrationContentHandlingConvertToText   = MethodIntegrationContentHandling("CONVERT_TO_TEXT")
)
View Source 
const (
	MethodIntegrationPassthroughBehaviorWhenNoMatch     = MethodIntegrationPassthroughBehavior("WHEN_NO_MATCH")
	MethodIntegrationPassthroughBehaviorWhenNoTemplates = MethodIntegrationPassthroughBehavior("WHEN_NO_TEMPLATES")
	MethodIntegrationPassthroughBehaviorNever           = MethodIntegrationPassthroughBehavior("NEVER")
)
View Source 
const (
	MethodIntegrationResponseContentHandlingConvertToBinary = MethodIntegrationResponseContentHandling("CONVERT_TO_BINARY")
	MethodIntegrationResponseContentHandlingConvertToText   = MethodIntegrationResponseContentHandling("CONVERT_TO_TEXT")
)
View Source 
const (
	MethodIntegrationTypeAws       = MethodIntegrationType("AWS")
	MethodIntegrationTypeAwsProxy  = MethodIntegrationType("AWS_PROXY")
	MethodIntegrationTypeHttp      = MethodIntegrationType("HTTP")
	MethodIntegrationTypeHttpProxy = MethodIntegrationType("HTTP_PROXY")
	MethodIntegrationTypeMock      = MethodIntegrationType("MOCK")
)
View Source 
const (
	UsagePlanKeyKeyTypeApiKey = UsagePlanKeyKeyType("API_KEY")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {
	pulumi.CustomResourceState

	AwsId pulumi.StringOutput `pulumi:"awsId"`
	// The ARN of an Amazon CloudWatch role for the current Account.
	CloudWatchRoleArn pulumi.StringPtrOutput `pulumi:"cloudWatchRoleArn"`
}

The “AWS::ApiGateway::Account“ resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one “AWS::ApiGateway::Account“ resource per region per account.

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.

func (*Account) ElementType 

func (*Account) ElementType() reflect.Type

func (*Account) ToAccountOutput 

func (i *Account) ToAccountOutput() AccountOutput

func (*Account) ToAccountOutputWithContext 

func (i *Account) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountArgs 

type AccountArgs struct {
	// The ARN of an Amazon CloudWatch role for the current Account.
	CloudWatchRoleArn pulumi.StringPtrInput
}

The set of arguments for constructing a Account resource.

func (AccountArgs) ElementType 

func (AccountArgs) ElementType() reflect.Type

type AccountInput 

type AccountInput interface {
	pulumi.Input

	ToAccountOutput() AccountOutput
	ToAccountOutputWithContext(ctx context.Context) AccountOutput
}

type AccountOutput 

type AccountOutput struct{ *pulumi.OutputState }

func (AccountOutput) AwsId added in v0.99.0 

func (o AccountOutput) AwsId() pulumi.StringOutput

func (AccountOutput) CloudWatchRoleArn added in v0.17.0 

func (o AccountOutput) CloudWatchRoleArn() pulumi.StringPtrOutput

The ARN of an Amazon CloudWatch role for the current Account.

func (AccountOutput) ElementType 

func (AccountOutput) ElementType() reflect.Type

func (AccountOutput) ToAccountOutput 

func (o AccountOutput) ToAccountOutput() AccountOutput

func (AccountOutput) ToAccountOutputWithContext 

func (o AccountOutput) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountState 

type AccountState struct {
}

func (AccountState) ElementType 

func (AccountState) ElementType() reflect.Type

type ApiKey 

type ApiKey struct {
	pulumi.CustomResourceState

	ApiKeyId pulumi.StringOutput `pulumi:"apiKeyId"`
	// An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
	CustomerId pulumi.StringPtrOutput `pulumi:"customerId"`
	// The description of the ApiKey.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies whether the ApiKey can be used by callers.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	// Specifies whether (“true“) or not (“false“) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
	GenerateDistinctId pulumi.BoolPtrOutput `pulumi:"generateDistinctId"`
	// A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
	//  If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
	StageKeys ApiKeyStageKeyArrayOutput `pulumi:"stageKeys"`
	// The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// Specifies a value of the API key.
	Value pulumi.StringPtrOutput `pulumi:"value"`
}

The “AWS::ApiGateway::ApiKey“ resource creates a unique key that you can distribute to clients who are executing API Gateway “Method“ resources that require an API key. To specify which API key clients must use, map the API key with the “RestApi“ and “Stage“ resources that include the methods that require a key.

## Example Usage ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiKeyName := cfg.Require("apiKeyName")
		customerId := cfg.Require("customerId")
		generateDistinctId := cfg.Require("generateDistinctId")
		_, err := apigateway.NewApiKey(ctx, "apiKey", &apigateway.ApiKeyArgs{
			CustomerId:         pulumi.String(customerId),
			GenerateDistinctId: pulumi.String(generateDistinctId),
			Name:               pulumi.String(apiKeyName),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiKeyName := cfg.Require("apiKeyName")
		customerId := cfg.Require("customerId")
		generateDistinctId := cfg.Require("generateDistinctId")
		_, err := apigateway.NewApiKey(ctx, "apiKey", &apigateway.ApiKeyArgs{
			CustomerId:         pulumi.String(customerId),
			GenerateDistinctId: pulumi.String(generateDistinctId),
			Name:               pulumi.String(apiKeyName),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

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.

func (*ApiKey) ElementType 

func (*ApiKey) ElementType() reflect.Type

func (*ApiKey) ToApiKeyOutput 

func (i *ApiKey) ToApiKeyOutput() ApiKeyOutput

func (*ApiKey) ToApiKeyOutputWithContext 

func (i *ApiKey) ToApiKeyOutputWithContext(ctx context.Context) ApiKeyOutput

type ApiKeyArgs 

type ApiKeyArgs struct {
	// An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
	CustomerId pulumi.StringPtrInput
	// The description of the ApiKey.
	Description pulumi.StringPtrInput
	// Specifies whether the ApiKey can be used by callers.
	Enabled pulumi.BoolPtrInput
	// Specifies whether (“true“) or not (“false“) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
	GenerateDistinctId pulumi.BoolPtrInput
	// A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
	//  If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	Name pulumi.StringPtrInput
	// DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
	StageKeys ApiKeyStageKeyArrayInput
	// The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.
	Tags aws.TagArrayInput
	// Specifies a value of the API key.
	Value pulumi.StringPtrInput
}

The set of arguments for constructing a ApiKey resource.

func (ApiKeyArgs) ElementType 

func (ApiKeyArgs) ElementType() reflect.Type

type ApiKeyInput 

type ApiKeyInput interface {
	pulumi.Input

	ToApiKeyOutput() ApiKeyOutput
	ToApiKeyOutputWithContext(ctx context.Context) ApiKeyOutput
}

type ApiKeyOutput 

type ApiKeyOutput struct{ *pulumi.OutputState }

func (ApiKeyOutput) ApiKeyId added in v0.72.0 

func (o ApiKeyOutput) ApiKeyId() pulumi.StringOutput

func (ApiKeyOutput) CustomerId added in v0.17.0 

func (o ApiKeyOutput) CustomerId() pulumi.StringPtrOutput

An MKT customer identifier, when integrating with the AWS SaaS Marketplace.

func (ApiKeyOutput) Description added in v0.17.0 

func (o ApiKeyOutput) Description() pulumi.StringPtrOutput

The description of the ApiKey.

func (ApiKeyOutput) ElementType 

func (ApiKeyOutput) ElementType() reflect.Type

func (ApiKeyOutput) Enabled added in v0.17.0 

func (o ApiKeyOutput) Enabled() pulumi.BoolPtrOutput

Specifies whether the ApiKey can be used by callers.

func (ApiKeyOutput) GenerateDistinctId added in v0.17.0 

func (o ApiKeyOutput) GenerateDistinctId() pulumi.BoolPtrOutput

Specifies whether (“true“) or not (“false“) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

func (ApiKeyOutput) Name added in v0.17.0 

func (o ApiKeyOutput) Name() pulumi.StringPtrOutput

A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). 

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

func (ApiKeyOutput) StageKeys added in v0.17.0 

func (o ApiKeyOutput) StageKeys() ApiKeyStageKeyArrayOutput

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

func (ApiKeyOutput) Tags added in v0.17.0 

func (o ApiKeyOutput) Tags() aws.TagArrayOutput

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.

func (ApiKeyOutput) ToApiKeyOutput 

func (o ApiKeyOutput) ToApiKeyOutput() ApiKeyOutput

func (ApiKeyOutput) ToApiKeyOutputWithContext 

func (o ApiKeyOutput) ToApiKeyOutputWithContext(ctx context.Context) ApiKeyOutput

func (ApiKeyOutput) Value added in v0.17.0 

func (o ApiKeyOutput) Value() pulumi.StringPtrOutput

Specifies a value of the API key.

type ApiKeyStageKey 

type ApiKeyStageKey struct {
	// The string identifier of the associated RestApi.
	RestApiId *string `pulumi:"restApiId"`
	// The stage name associated with the stage key.
	StageName *string `pulumi:"stageName"`
}

“StageKey“ is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.

type ApiKeyStageKeyArgs 

type ApiKeyStageKeyArgs struct {
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringPtrInput `pulumi:"restApiId"`
	// The stage name associated with the stage key.
	StageName pulumi.StringPtrInput `pulumi:"stageName"`
}

“StageKey“ is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.

func (ApiKeyStageKeyArgs) ElementType 

func (ApiKeyStageKeyArgs) ElementType() reflect.Type

func (ApiKeyStageKeyArgs) ToApiKeyStageKeyOutput 

func (i ApiKeyStageKeyArgs) ToApiKeyStageKeyOutput() ApiKeyStageKeyOutput

func (ApiKeyStageKeyArgs) ToApiKeyStageKeyOutputWithContext 

func (i ApiKeyStageKeyArgs) ToApiKeyStageKeyOutputWithContext(ctx context.Context) ApiKeyStageKeyOutput

type ApiKeyStageKeyArray 

type ApiKeyStageKeyArray []ApiKeyStageKeyInput

func (ApiKeyStageKeyArray) ElementType 

func (ApiKeyStageKeyArray) ElementType() reflect.Type

func (ApiKeyStageKeyArray) ToApiKeyStageKeyArrayOutput 

func (i ApiKeyStageKeyArray) ToApiKeyStageKeyArrayOutput() ApiKeyStageKeyArrayOutput

func (ApiKeyStageKeyArray) ToApiKeyStageKeyArrayOutputWithContext 

func (i ApiKeyStageKeyArray) ToApiKeyStageKeyArrayOutputWithContext(ctx context.Context) ApiKeyStageKeyArrayOutput

type ApiKeyStageKeyArrayInput 

type ApiKeyStageKeyArrayInput interface {
	pulumi.Input

	ToApiKeyStageKeyArrayOutput() ApiKeyStageKeyArrayOutput
	ToApiKeyStageKeyArrayOutputWithContext(context.Context) ApiKeyStageKeyArrayOutput
}

ApiKeyStageKeyArrayInput is an input type that accepts ApiKeyStageKeyArray and ApiKeyStageKeyArrayOutput values. You can construct a concrete instance of `ApiKeyStageKeyArrayInput` via: 

ApiKeyStageKeyArray{ ApiKeyStageKeyArgs{...} }

type ApiKeyStageKeyArrayOutput 

type ApiKeyStageKeyArrayOutput struct{ *pulumi.OutputState }

func (ApiKeyStageKeyArrayOutput) ElementType 

func (ApiKeyStageKeyArrayOutput) ElementType() reflect.Type

func (ApiKeyStageKeyArrayOutput) Index 

func (o ApiKeyStageKeyArrayOutput) Index(i pulumi.IntInput) ApiKeyStageKeyOutput

func (ApiKeyStageKeyArrayOutput) ToApiKeyStageKeyArrayOutput 

func (o ApiKeyStageKeyArrayOutput) ToApiKeyStageKeyArrayOutput() ApiKeyStageKeyArrayOutput

func (ApiKeyStageKeyArrayOutput) ToApiKeyStageKeyArrayOutputWithContext 

func (o ApiKeyStageKeyArrayOutput) ToApiKeyStageKeyArrayOutputWithContext(ctx context.Context) ApiKeyStageKeyArrayOutput

type ApiKeyStageKeyInput 

type ApiKeyStageKeyInput interface {
	pulumi.Input

	ToApiKeyStageKeyOutput() ApiKeyStageKeyOutput
	ToApiKeyStageKeyOutputWithContext(context.Context) ApiKeyStageKeyOutput
}

ApiKeyStageKeyInput is an input type that accepts ApiKeyStageKeyArgs and ApiKeyStageKeyOutput values. You can construct a concrete instance of `ApiKeyStageKeyInput` via: 

ApiKeyStageKeyArgs{...}

type ApiKeyStageKeyOutput 

type ApiKeyStageKeyOutput struct{ *pulumi.OutputState }

“StageKey“ is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.

func (ApiKeyStageKeyOutput) ElementType 

func (ApiKeyStageKeyOutput) ElementType() reflect.Type

func (ApiKeyStageKeyOutput) RestApiId 

func (o ApiKeyStageKeyOutput) RestApiId() pulumi.StringPtrOutput

The string identifier of the associated RestApi.

func (ApiKeyStageKeyOutput) StageName 

func (o ApiKeyStageKeyOutput) StageName() pulumi.StringPtrOutput

The stage name associated with the stage key.

func (ApiKeyStageKeyOutput) ToApiKeyStageKeyOutput 

func (o ApiKeyStageKeyOutput) ToApiKeyStageKeyOutput() ApiKeyStageKeyOutput

func (ApiKeyStageKeyOutput) ToApiKeyStageKeyOutputWithContext 

func (o ApiKeyStageKeyOutput) ToApiKeyStageKeyOutputWithContext(ctx context.Context) ApiKeyStageKeyOutput

type ApiKeyState 

type ApiKeyState struct {
}

func (ApiKeyState) ElementType 

func (ApiKeyState) ElementType() reflect.Type

type ApiKeyTag 

type ApiKeyTag struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key string `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value string `pulumi:"value"`
}

type Authorizer 

type Authorizer struct {
	pulumi.CustomResourceState

	// Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
	AuthType pulumi.StringPtrOutput `pulumi:"authType"`
	// Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
	AuthorizerCredentials pulumi.StringPtrOutput `pulumi:"authorizerCredentials"`
	AuthorizerId          pulumi.StringOutput    `pulumi:"authorizerId"`
	// The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
	AuthorizerResultTtlInSeconds pulumi.IntPtrOutput `pulumi:"authorizerResultTtlInSeconds"`
	// Specifies the authorizer's Uniform Resource Identifier (URI). For “TOKEN“ or “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where “{region}“ is the same as the region hosting the Lambda function, “path“ indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.
	AuthorizerUri pulumi.StringPtrOutput `pulumi:"authorizerUri"`
	// The identity source for which authorization is requested. For a “TOKEN“ or “COGNITO_USER_POOLS“ authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is “Auth“, the header mapping expression is “method.request.header.Auth“. For the “REQUEST“ authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an “Auth“ header, a “Name“ query string parameter are defined as identity sources, this value is “method.request.header.Auth, method.request.querystring.Name“. These parameters will be used to derive the authorization caching key and to perform runtime validation of the “REQUEST“ authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
	IdentitySource pulumi.StringPtrOutput `pulumi:"identitySource"`
	// A validation expression for the incoming identity token. For “TOKEN“ authorizers, this value is a regular expression. For “COGNITO_USER_POOLS“ authorizers, API Gateway will match the “aud“ field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the “REQUEST“ authorizer.
	IdentityValidationExpression pulumi.StringPtrOutput `pulumi:"identityValidationExpression"`
	// The name of the authorizer.
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of the Amazon Cognito user pool ARNs for the “COGNITO_USER_POOLS“ authorizer. Each element is of this format: “arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}“. For a “TOKEN“ or “REQUEST“ authorizer, this is not defined.
	ProviderArns pulumi.StringArrayOutput `pulumi:"providerArns"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// The authorizer type. Valid 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, and “COGNITO_USER_POOLS“ for using an Amazon Cognito user pool.
	Type pulumi.StringOutput `pulumi:"type"`
}

The “AWS::ApiGateway::Authorizer“ resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.

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.

func (*Authorizer) ElementType 

func (*Authorizer) ElementType() reflect.Type

func (*Authorizer) ToAuthorizerOutput 

func (i *Authorizer) ToAuthorizerOutput() AuthorizerOutput

func (*Authorizer) ToAuthorizerOutputWithContext 

func (i *Authorizer) ToAuthorizerOutputWithContext(ctx context.Context) AuthorizerOutput

type AuthorizerArgs 

type AuthorizerArgs struct {
	// Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
	AuthType pulumi.StringPtrInput
	// Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
	AuthorizerCredentials pulumi.StringPtrInput
	// The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
	AuthorizerResultTtlInSeconds pulumi.IntPtrInput
	// Specifies the authorizer's Uniform Resource Identifier (URI). For “TOKEN“ or “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where “{region}“ is the same as the region hosting the Lambda function, “path“ indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.
	AuthorizerUri pulumi.StringPtrInput
	// The identity source for which authorization is requested. For a “TOKEN“ or “COGNITO_USER_POOLS“ authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is “Auth“, the header mapping expression is “method.request.header.Auth“. For the “REQUEST“ authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an “Auth“ header, a “Name“ query string parameter are defined as identity sources, this value is “method.request.header.Auth, method.request.querystring.Name“. These parameters will be used to derive the authorization caching key and to perform runtime validation of the “REQUEST“ authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
	IdentitySource pulumi.StringPtrInput
	// A validation expression for the incoming identity token. For “TOKEN“ authorizers, this value is a regular expression. For “COGNITO_USER_POOLS“ authorizers, API Gateway will match the “aud“ field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the “REQUEST“ authorizer.
	IdentityValidationExpression pulumi.StringPtrInput
	// The name of the authorizer.
	Name pulumi.StringPtrInput
	// A list of the Amazon Cognito user pool ARNs for the “COGNITO_USER_POOLS“ authorizer. Each element is of this format: “arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}“. For a “TOKEN“ or “REQUEST“ authorizer, this is not defined.
	ProviderArns pulumi.StringArrayInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput
	// The authorizer type. Valid 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, and “COGNITO_USER_POOLS“ for using an Amazon Cognito user pool.
	Type pulumi.StringInput
}

The set of arguments for constructing a Authorizer resource.

func (AuthorizerArgs) ElementType 

func (AuthorizerArgs) ElementType() reflect.Type

type AuthorizerInput 

type AuthorizerInput interface {
	pulumi.Input

	ToAuthorizerOutput() AuthorizerOutput
	ToAuthorizerOutputWithContext(ctx context.Context) AuthorizerOutput
}

type AuthorizerOutput 

type AuthorizerOutput struct{ *pulumi.OutputState }

func (AuthorizerOutput) AuthType added in v0.17.0 

func (o AuthorizerOutput) AuthType() pulumi.StringPtrOutput

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

func (AuthorizerOutput) AuthorizerCredentials added in v0.17.0 

func (o AuthorizerOutput) AuthorizerCredentials() pulumi.StringPtrOutput

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

func (AuthorizerOutput) AuthorizerId added in v0.17.0 

func (o AuthorizerOutput) AuthorizerId() pulumi.StringOutput

func (AuthorizerOutput) AuthorizerResultTtlInSeconds added in v0.17.0 

func (o AuthorizerOutput) AuthorizerResultTtlInSeconds() pulumi.IntPtrOutput

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

func (AuthorizerOutput) AuthorizerUri added in v0.17.0 

func (o AuthorizerOutput) AuthorizerUri() pulumi.StringPtrOutput

Specifies the authorizer's Uniform Resource Identifier (URI). For “TOKEN“ or “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where “{region}“ is the same as the region hosting the Lambda function, “path“ indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.

func (AuthorizerOutput) ElementType 

func (AuthorizerOutput) ElementType() reflect.Type

func (AuthorizerOutput) IdentitySource added in v0.17.0 

func (o AuthorizerOutput) IdentitySource() pulumi.StringPtrOutput

The identity source for which authorization is requested. For a “TOKEN“ or “COGNITO_USER_POOLS“ authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is “Auth“, the header mapping expression is “method.request.header.Auth“. For the “REQUEST“ authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an “Auth“ header, a “Name“ query string parameter are defined as identity sources, this value is “method.request.header.Auth, method.request.querystring.Name“. These parameters will be used to derive the authorization caching key and to perform runtime validation of the “REQUEST“ authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

func (AuthorizerOutput) IdentityValidationExpression added in v0.17.0 

func (o AuthorizerOutput) IdentityValidationExpression() pulumi.StringPtrOutput

A validation expression for the incoming identity token. For “TOKEN“ authorizers, this value is a regular expression. For “COGNITO_USER_POOLS“ authorizers, API Gateway will match the “aud“ field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the “REQUEST“ authorizer.

func (AuthorizerOutput) Name added in v0.17.0 

func (o AuthorizerOutput) Name() pulumi.StringOutput

The name of the authorizer.

func (AuthorizerOutput) ProviderArns added in v0.72.0 

func (o AuthorizerOutput) ProviderArns() pulumi.StringArrayOutput

A list of the Amazon Cognito user pool ARNs for the “COGNITO_USER_POOLS“ authorizer. Each element is of this format: “arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}“. For a “TOKEN“ or “REQUEST“ authorizer, this is not defined.

func (AuthorizerOutput) RestApiId added in v0.17.0 

func (o AuthorizerOutput) RestApiId() pulumi.StringOutput

The string identifier of the associated RestApi.

func (AuthorizerOutput) ToAuthorizerOutput 

func (o AuthorizerOutput) ToAuthorizerOutput() AuthorizerOutput

func (AuthorizerOutput) ToAuthorizerOutputWithContext 

func (o AuthorizerOutput) ToAuthorizerOutputWithContext(ctx context.Context) AuthorizerOutput

func (AuthorizerOutput) Type added in v0.17.0 

func (o AuthorizerOutput) Type() pulumi.StringOutput

The authorizer type. Valid 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, and “COGNITO_USER_POOLS“ for using an Amazon Cognito user pool.

type AuthorizerState 

type AuthorizerState struct {
}

func (AuthorizerState) ElementType 

func (AuthorizerState) ElementType() reflect.Type

type BasePathMapping 

type BasePathMapping struct {
	pulumi.CustomResourceState

	// The base path name that callers of the API must provide as part of the URL after the domain name.
	BasePath pulumi.StringPtrOutput `pulumi:"basePath"`
	// The domain name of the BasePathMapping resource to be described.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringPtrOutput `pulumi:"restApiId"`
	// The name of the associated stage.
	Stage pulumi.StringPtrOutput `pulumi:"stage"`
}

The “AWS::ApiGateway::BasePathMapping“ resource creates a base path that clients who call your API must use in the invocation URL.

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.

func (*BasePathMapping) ElementType 

func (*BasePathMapping) ElementType() reflect.Type

func (*BasePathMapping) ToBasePathMappingOutput 

func (i *BasePathMapping) ToBasePathMappingOutput() BasePathMappingOutput

func (*BasePathMapping) ToBasePathMappingOutputWithContext 

func (i *BasePathMapping) ToBasePathMappingOutputWithContext(ctx context.Context) BasePathMappingOutput

type BasePathMappingArgs 

type BasePathMappingArgs struct {
	// The base path name that callers of the API must provide as part of the URL after the domain name.
	BasePath pulumi.StringPtrInput
	// The domain name of the BasePathMapping resource to be described.
	DomainName pulumi.StringInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringPtrInput
	// The name of the associated stage.
	Stage pulumi.StringPtrInput
}

The set of arguments for constructing a BasePathMapping resource.

func (BasePathMappingArgs) ElementType 

func (BasePathMappingArgs) ElementType() reflect.Type

type BasePathMappingInput 

type BasePathMappingInput interface {
	pulumi.Input

	ToBasePathMappingOutput() BasePathMappingOutput
	ToBasePathMappingOutputWithContext(ctx context.Context) BasePathMappingOutput
}

type BasePathMappingOutput 

type BasePathMappingOutput struct{ *pulumi.OutputState }

func (BasePathMappingOutput) BasePath added in v0.17.0 

func (o BasePathMappingOutput) BasePath() pulumi.StringPtrOutput

The base path name that callers of the API must provide as part of the URL after the domain name.

func (BasePathMappingOutput) DomainName added in v0.17.0 

func (o BasePathMappingOutput) DomainName() pulumi.StringOutput

The domain name of the BasePathMapping resource to be described.

func (BasePathMappingOutput) ElementType 

func (BasePathMappingOutput) ElementType() reflect.Type

func (BasePathMappingOutput) RestApiId added in v0.17.0 

func (o BasePathMappingOutput) RestApiId() pulumi.StringPtrOutput

The string identifier of the associated RestApi.

func (BasePathMappingOutput) Stage added in v0.17.0 

func (o BasePathMappingOutput) Stage() pulumi.StringPtrOutput

The name of the associated stage.

func (BasePathMappingOutput) ToBasePathMappingOutput 

func (o BasePathMappingOutput) ToBasePathMappingOutput() BasePathMappingOutput

func (BasePathMappingOutput) ToBasePathMappingOutputWithContext 

func (o BasePathMappingOutput) ToBasePathMappingOutputWithContext(ctx context.Context) BasePathMappingOutput

type BasePathMappingState 

type BasePathMappingState struct {
}

func (BasePathMappingState) ElementType 

func (BasePathMappingState) ElementType() reflect.Type

type ClientCertificate 

type ClientCertificate struct {
	pulumi.CustomResourceState

	ClientCertificateId pulumi.StringOutput `pulumi:"clientCertificateId"`
	// The description of the client certificate.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The collection of tags. Each tag element is associated with a given resource.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

The “AWS::ApiGateway::ClientCertificate“ resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.

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.

func (*ClientCertificate) ElementType 

func (*ClientCertificate) ElementType() reflect.Type

func (*ClientCertificate) ToClientCertificateOutput 

func (i *ClientCertificate) ToClientCertificateOutput() ClientCertificateOutput

func (*ClientCertificate) ToClientCertificateOutputWithContext 

func (i *ClientCertificate) ToClientCertificateOutputWithContext(ctx context.Context) ClientCertificateOutput

type ClientCertificateArgs 

type ClientCertificateArgs struct {
	// The description of the client certificate.
	Description pulumi.StringPtrInput
	// The collection of tags. Each tag element is associated with a given resource.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a ClientCertificate resource.

func (ClientCertificateArgs) ElementType 

func (ClientCertificateArgs) ElementType() reflect.Type

type ClientCertificateInput 

type ClientCertificateInput interface {
	pulumi.Input

	ToClientCertificateOutput() ClientCertificateOutput
	ToClientCertificateOutputWithContext(ctx context.Context) ClientCertificateOutput
}

type ClientCertificateOutput 

type ClientCertificateOutput struct{ *pulumi.OutputState }

func (ClientCertificateOutput) ClientCertificateId added in v0.17.0 

func (o ClientCertificateOutput) ClientCertificateId() pulumi.StringOutput

func (ClientCertificateOutput) Description added in v0.17.0 

func (o ClientCertificateOutput) Description() pulumi.StringPtrOutput

The description of the client certificate.

func (ClientCertificateOutput) ElementType 

func (ClientCertificateOutput) ElementType() reflect.Type

func (ClientCertificateOutput) Tags added in v0.17.0 

func (o ClientCertificateOutput) Tags() aws.TagArrayOutput

The collection of tags. Each tag element is associated with a given resource.

func (ClientCertificateOutput) ToClientCertificateOutput 

func (o ClientCertificateOutput) ToClientCertificateOutput() ClientCertificateOutput

func (ClientCertificateOutput) ToClientCertificateOutputWithContext 

func (o ClientCertificateOutput) ToClientCertificateOutputWithContext(ctx context.Context) ClientCertificateOutput

type ClientCertificateState 

type ClientCertificateState struct {
}

func (ClientCertificateState) ElementType 

func (ClientCertificateState) ElementType() reflect.Type

type ClientCertificateTag 

type ClientCertificateTag struct {
	Key   string `pulumi:"key"`
	Value string `pulumi:"value"`
}

type Deployment 

type Deployment struct {
	pulumi.CustomResourceState

	// The input configuration for a canary deployment.
	DeploymentCanarySettings DeploymentCanarySettingsPtrOutput `pulumi:"deploymentCanarySettings"`
	DeploymentId             pulumi.StringOutput               `pulumi:"deploymentId"`
	// The description for the Deployment resource to create.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
	StageDescription DeploymentStageDescriptionPtrOutput `pulumi:"stageDescription"`
	// The name of the Stage resource for the Deployment resource to create.
	StageName pulumi.StringPtrOutput `pulumi:"stageName"`
}

The “AWS::ApiGateway::Deployment“ resource deploys an API Gateway “RestApi“ resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

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.

func (*Deployment) ElementType 

func (*Deployment) ElementType() reflect.Type

func (*Deployment) ToDeploymentOutput 

func (i *Deployment) ToDeploymentOutput() DeploymentOutput

func (*Deployment) ToDeploymentOutputWithContext 

func (i *Deployment) ToDeploymentOutputWithContext(ctx context.Context) DeploymentOutput

type DeploymentAccessLogSetting 

type DeploymentAccessLogSetting 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-“.
	DestinationArn *string `pulumi:"destinationArn"`
	// A single line format of the access logs of data, as specified by selected $context variables. The format must include at least “$context.requestId“.
	Format *string `pulumi:"format"`
}

The “AccessLogSetting“ property type specifies settings for logging access in this stage. 

``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.

type DeploymentAccessLogSettingArgs 

type DeploymentAccessLogSettingArgs 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-“.
	DestinationArn pulumi.StringPtrInput `pulumi:"destinationArn"`
	// A single line format of the access logs of data, as specified by selected $context variables. The format must include at least “$context.requestId“.
	Format pulumi.StringPtrInput `pulumi:"format"`
}

The “AccessLogSetting“ property type specifies settings for logging access in this stage. 

``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.

func (DeploymentAccessLogSettingArgs) ElementType 

func (DeploymentAccessLogSettingArgs) ElementType() reflect.Type

func (DeploymentAccessLogSettingArgs) ToDeploymentAccessLogSettingOutput 

func (i DeploymentAccessLogSettingArgs) ToDeploymentAccessLogSettingOutput() DeploymentAccessLogSettingOutput

func (DeploymentAccessLogSettingArgs) ToDeploymentAccessLogSettingOutputWithContext 

func (i DeploymentAccessLogSettingArgs) ToDeploymentAccessLogSettingOutputWithContext(ctx context.Context) DeploymentAccessLogSettingOutput

func (DeploymentAccessLogSettingArgs) ToDeploymentAccessLogSettingPtrOutput 

func (i DeploymentAccessLogSettingArgs) ToDeploymentAccessLogSettingPtrOutput() DeploymentAccessLogSettingPtrOutput

func (DeploymentAccessLogSettingArgs) ToDeploymentAccessLogSettingPtrOutputWithContext 

func (i DeploymentAccessLogSettingArgs) ToDeploymentAccessLogSettingPtrOutputWithContext(ctx context.Context) DeploymentAccessLogSettingPtrOutput

type DeploymentAccessLogSettingInput 

type DeploymentAccessLogSettingInput interface {
	pulumi.Input

	ToDeploymentAccessLogSettingOutput() DeploymentAccessLogSettingOutput
	ToDeploymentAccessLogSettingOutputWithContext(context.Context) DeploymentAccessLogSettingOutput
}

DeploymentAccessLogSettingInput is an input type that accepts DeploymentAccessLogSettingArgs and DeploymentAccessLogSettingOutput values. You can construct a concrete instance of `DeploymentAccessLogSettingInput` via: 

DeploymentAccessLogSettingArgs{...}

type DeploymentAccessLogSettingOutput 

type DeploymentAccessLogSettingOutput struct{ *pulumi.OutputState }

The “AccessLogSetting“ property type specifies settings for logging access in this stage. 

``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.

func (DeploymentAccessLogSettingOutput) DestinationArn 

func (o DeploymentAccessLogSettingOutput) DestinationArn() pulumi.StringPtrOutput

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-“.

func (DeploymentAccessLogSettingOutput) ElementType 

func (DeploymentAccessLogSettingOutput) ElementType() reflect.Type

func (DeploymentAccessLogSettingOutput) Format 

func (o DeploymentAccessLogSettingOutput) Format() pulumi.StringPtrOutput

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least “$context.requestId“.

func (DeploymentAccessLogSettingOutput) ToDeploymentAccessLogSettingOutput 

func (o DeploymentAccessLogSettingOutput) ToDeploymentAccessLogSettingOutput() DeploymentAccessLogSettingOutput

func (DeploymentAccessLogSettingOutput) ToDeploymentAccessLogSettingOutputWithContext 

func (o DeploymentAccessLogSettingOutput) ToDeploymentAccessLogSettingOutputWithContext(ctx context.Context) DeploymentAccessLogSettingOutput

func (DeploymentAccessLogSettingOutput) ToDeploymentAccessLogSettingPtrOutput 

func (o DeploymentAccessLogSettingOutput) ToDeploymentAccessLogSettingPtrOutput() DeploymentAccessLogSettingPtrOutput

func (DeploymentAccessLogSettingOutput) ToDeploymentAccessLogSettingPtrOutputWithContext 

func (o DeploymentAccessLogSettingOutput) ToDeploymentAccessLogSettingPtrOutputWithContext(ctx context.Context) DeploymentAccessLogSettingPtrOutput

type DeploymentAccessLogSettingPtrInput 

type DeploymentAccessLogSettingPtrInput interface {
	pulumi.Input

	ToDeploymentAccessLogSettingPtrOutput() DeploymentAccessLogSettingPtrOutput
	ToDeploymentAccessLogSettingPtrOutputWithContext(context.Context) DeploymentAccessLogSettingPtrOutput
}

DeploymentAccessLogSettingPtrInput is an input type that accepts DeploymentAccessLogSettingArgs, DeploymentAccessLogSettingPtr and DeploymentAccessLogSettingPtrOutput values. You can construct a concrete instance of `DeploymentAccessLogSettingPtrInput` via: 

        DeploymentAccessLogSettingArgs{...}

or:

        nil

func DeploymentAccessLogSettingPtr 

func DeploymentAccessLogSettingPtr(v *DeploymentAccessLogSettingArgs) DeploymentAccessLogSettingPtrInput

type DeploymentAccessLogSettingPtrOutput 

type DeploymentAccessLogSettingPtrOutput struct{ *pulumi.OutputState }

func (DeploymentAccessLogSettingPtrOutput) DestinationArn 

func (o DeploymentAccessLogSettingPtrOutput) DestinationArn() pulumi.StringPtrOutput

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-“.

func (DeploymentAccessLogSettingPtrOutput) Elem 

func (o DeploymentAccessLogSettingPtrOutput) Elem() DeploymentAccessLogSettingOutput

func (DeploymentAccessLogSettingPtrOutput) ElementType 

func (DeploymentAccessLogSettingPtrOutput) ElementType() reflect.Type

func (DeploymentAccessLogSettingPtrOutput) Format 

func (o DeploymentAccessLogSettingPtrOutput) Format() pulumi.StringPtrOutput

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least “$context.requestId“.

func (DeploymentAccessLogSettingPtrOutput) ToDeploymentAccessLogSettingPtrOutput 

func (o DeploymentAccessLogSettingPtrOutput) ToDeploymentAccessLogSettingPtrOutput() DeploymentAccessLogSettingPtrOutput

func (DeploymentAccessLogSettingPtrOutput) ToDeploymentAccessLogSettingPtrOutputWithContext 

func (o DeploymentAccessLogSettingPtrOutput) ToDeploymentAccessLogSettingPtrOutputWithContext(ctx context.Context) DeploymentAccessLogSettingPtrOutput

type DeploymentArgs 

type DeploymentArgs struct {
	// The input configuration for a canary deployment.
	DeploymentCanarySettings DeploymentCanarySettingsPtrInput
	// The description for the Deployment resource to create.
	Description pulumi.StringPtrInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput
	// The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
	StageDescription DeploymentStageDescriptionPtrInput
	// The name of the Stage resource for the Deployment resource to create.
	StageName pulumi.StringPtrInput
}

The set of arguments for constructing a Deployment resource.

func (DeploymentArgs) ElementType 

func (DeploymentArgs) ElementType() reflect.Type

type DeploymentCanarySetting 

type DeploymentCanarySetting struct {
	// The percent (0-100) of traffic diverted to a canary deployment.
	PercentTraffic *float64 `pulumi:"percentTraffic"`
	// Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
	StageVariableOverrides map[string]string `pulumi:"stageVariableOverrides"`
	// A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
	UseStageCache *bool `pulumi:"useStageCache"`
}

The “CanarySetting“ property type specifies settings for the canary deployment in this stage. 

``CanarySetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.

type DeploymentCanarySettingArgs 

type DeploymentCanarySettingArgs struct {
	// The percent (0-100) of traffic diverted to a canary deployment.
	PercentTraffic pulumi.Float64PtrInput `pulumi:"percentTraffic"`
	// Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
	StageVariableOverrides pulumi.StringMapInput `pulumi:"stageVariableOverrides"`
	// A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
	UseStageCache pulumi.BoolPtrInput `pulumi:"useStageCache"`
}

The “CanarySetting“ property type specifies settings for the canary deployment in this stage. 

``CanarySetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.

func (DeploymentCanarySettingArgs) ElementType 

func (DeploymentCanarySettingArgs) ElementType() reflect.Type

func (DeploymentCanarySettingArgs) ToDeploymentCanarySettingOutput 

func (i DeploymentCanarySettingArgs) ToDeploymentCanarySettingOutput() DeploymentCanarySettingOutput

func (DeploymentCanarySettingArgs) ToDeploymentCanarySettingOutputWithContext 

func (i DeploymentCanarySettingArgs) ToDeploymentCanarySettingOutputWithContext(ctx context.Context) DeploymentCanarySettingOutput

func (DeploymentCanarySettingArgs) ToDeploymentCanarySettingPtrOutput 

func (i DeploymentCanarySettingArgs) ToDeploymentCanarySettingPtrOutput() DeploymentCanarySettingPtrOutput

func (DeploymentCanarySettingArgs) ToDeploymentCanarySettingPtrOutputWithContext 

func (i DeploymentCanarySettingArgs) ToDeploymentCanarySettingPtrOutputWithContext(ctx context.Context) DeploymentCanarySettingPtrOutput

type DeploymentCanarySettingInput 

type DeploymentCanarySettingInput interface {
	pulumi.Input

	ToDeploymentCanarySettingOutput() DeploymentCanarySettingOutput
	ToDeploymentCanarySettingOutputWithContext(context.Context) DeploymentCanarySettingOutput
}

DeploymentCanarySettingInput is an input type that accepts DeploymentCanarySettingArgs and DeploymentCanarySettingOutput values. You can construct a concrete instance of `DeploymentCanarySettingInput` via: 

DeploymentCanarySettingArgs{...}

type DeploymentCanarySettingOutput 

type DeploymentCanarySettingOutput struct{ *pulumi.OutputState }

The “CanarySetting“ property type specifies settings for the canary deployment in this stage. 

``CanarySetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.

func (DeploymentCanarySettingOutput) ElementType 

func (DeploymentCanarySettingOutput) ElementType() reflect.Type

func (DeploymentCanarySettingOutput) PercentTraffic 

func (o DeploymentCanarySettingOutput) PercentTraffic() pulumi.Float64PtrOutput

The percent (0-100) of traffic diverted to a canary deployment.

func (DeploymentCanarySettingOutput) StageVariableOverrides 

func (o DeploymentCanarySettingOutput) StageVariableOverrides() pulumi.StringMapOutput

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

func (DeploymentCanarySettingOutput) ToDeploymentCanarySettingOutput 

func (o DeploymentCanarySettingOutput) ToDeploymentCanarySettingOutput() DeploymentCanarySettingOutput

func (DeploymentCanarySettingOutput) ToDeploymentCanarySettingOutputWithContext 

func (o DeploymentCanarySettingOutput) ToDeploymentCanarySettingOutputWithContext(ctx context.Context) DeploymentCanarySettingOutput

func (DeploymentCanarySettingOutput) ToDeploymentCanarySettingPtrOutput 

func (o DeploymentCanarySettingOutput) ToDeploymentCanarySettingPtrOutput() DeploymentCanarySettingPtrOutput

func (DeploymentCanarySettingOutput) ToDeploymentCanarySettingPtrOutputWithContext 

func (o DeploymentCanarySettingOutput) ToDeploymentCanarySettingPtrOutputWithContext(ctx context.Context) DeploymentCanarySettingPtrOutput

func (DeploymentCanarySettingOutput) UseStageCache 

func (o DeploymentCanarySettingOutput) UseStageCache() pulumi.BoolPtrOutput

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

type DeploymentCanarySettingPtrInput 

type DeploymentCanarySettingPtrInput interface {
	pulumi.Input

	ToDeploymentCanarySettingPtrOutput() DeploymentCanarySettingPtrOutput
	ToDeploymentCanarySettingPtrOutputWithContext(context.Context) DeploymentCanarySettingPtrOutput
}

DeploymentCanarySettingPtrInput is an input type that accepts DeploymentCanarySettingArgs, DeploymentCanarySettingPtr and DeploymentCanarySettingPtrOutput values. You can construct a concrete instance of `DeploymentCanarySettingPtrInput` via: 

        DeploymentCanarySettingArgs{...}

or:

        nil

func DeploymentCanarySettingPtr 

func DeploymentCanarySettingPtr(v *DeploymentCanarySettingArgs) DeploymentCanarySettingPtrInput

type DeploymentCanarySettingPtrOutput 

type DeploymentCanarySettingPtrOutput struct{ *pulumi.OutputState }

func (DeploymentCanarySettingPtrOutput) Elem 

func (o DeploymentCanarySettingPtrOutput) Elem() DeploymentCanarySettingOutput

func (DeploymentCanarySettingPtrOutput) ElementType 

func (DeploymentCanarySettingPtrOutput) ElementType() reflect.Type

func (DeploymentCanarySettingPtrOutput) PercentTraffic 

func (o DeploymentCanarySettingPtrOutput) PercentTraffic() pulumi.Float64PtrOutput

The percent (0-100) of traffic diverted to a canary deployment.

func (DeploymentCanarySettingPtrOutput) StageVariableOverrides 

func (o DeploymentCanarySettingPtrOutput) StageVariableOverrides() pulumi.StringMapOutput

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

func (DeploymentCanarySettingPtrOutput) ToDeploymentCanarySettingPtrOutput 

func (o DeploymentCanarySettingPtrOutput) ToDeploymentCanarySettingPtrOutput() DeploymentCanarySettingPtrOutput

func (DeploymentCanarySettingPtrOutput) ToDeploymentCanarySettingPtrOutputWithContext 

func (o DeploymentCanarySettingPtrOutput) ToDeploymentCanarySettingPtrOutputWithContext(ctx context.Context) DeploymentCanarySettingPtrOutput

func (DeploymentCanarySettingPtrOutput) UseStageCache 

func (o DeploymentCanarySettingPtrOutput) UseStageCache() pulumi.BoolPtrOutput

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

type DeploymentCanarySettings added in v0.2.0 

type DeploymentCanarySettings struct {
	// The percentage (0.0-100.0) of traffic routed to the canary deployment.
	PercentTraffic *float64 `pulumi:"percentTraffic"`
	// A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
	StageVariableOverrides map[string]string `pulumi:"stageVariableOverrides"`
	// A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
	UseStageCache *bool `pulumi:"useStageCache"`
}

The “DeploymentCanarySettings“ property type specifies settings for the canary deployment.

type DeploymentCanarySettingsArgs added in v0.2.0 

type DeploymentCanarySettingsArgs struct {
	// The percentage (0.0-100.0) of traffic routed to the canary deployment.
	PercentTraffic pulumi.Float64PtrInput `pulumi:"percentTraffic"`
	// A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
	StageVariableOverrides pulumi.StringMapInput `pulumi:"stageVariableOverrides"`
	// A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
	UseStageCache pulumi.BoolPtrInput `pulumi:"useStageCache"`
}

The “DeploymentCanarySettings“ property type specifies settings for the canary deployment.

func (DeploymentCanarySettingsArgs) ElementType added in v0.2.0 

func (DeploymentCanarySettingsArgs) ElementType() reflect.Type

func (DeploymentCanarySettingsArgs) ToDeploymentCanarySettingsOutput added in v0.2.0 

func (i DeploymentCanarySettingsArgs) ToDeploymentCanarySettingsOutput() DeploymentCanarySettingsOutput

func (DeploymentCanarySettingsArgs) ToDeploymentCanarySettingsOutputWithContext added in v0.2.0 

func (i DeploymentCanarySettingsArgs) ToDeploymentCanarySettingsOutputWithContext(ctx context.Context) DeploymentCanarySettingsOutput

func (DeploymentCanarySettingsArgs) ToDeploymentCanarySettingsPtrOutput added in v0.2.0 

func (i DeploymentCanarySettingsArgs) ToDeploymentCanarySettingsPtrOutput() DeploymentCanarySettingsPtrOutput

func (DeploymentCanarySettingsArgs) ToDeploymentCanarySettingsPtrOutputWithContext added in v0.2.0 

func (i DeploymentCanarySettingsArgs) ToDeploymentCanarySettingsPtrOutputWithContext(ctx context.Context) DeploymentCanarySettingsPtrOutput

type DeploymentCanarySettingsInput added in v0.2.0 

type DeploymentCanarySettingsInput interface {
	pulumi.Input

	ToDeploymentCanarySettingsOutput() DeploymentCanarySettingsOutput
	ToDeploymentCanarySettingsOutputWithContext(context.Context) DeploymentCanarySettingsOutput
}

DeploymentCanarySettingsInput is an input type that accepts DeploymentCanarySettingsArgs and DeploymentCanarySettingsOutput values. You can construct a concrete instance of `DeploymentCanarySettingsInput` via: 

DeploymentCanarySettingsArgs{...}

type DeploymentCanarySettingsOutput added in v0.2.0 

type DeploymentCanarySettingsOutput struct{ *pulumi.OutputState }

The “DeploymentCanarySettings“ property type specifies settings for the canary deployment.

func (DeploymentCanarySettingsOutput) ElementType added in v0.2.0 

func (DeploymentCanarySettingsOutput) ElementType() reflect.Type

func (DeploymentCanarySettingsOutput) PercentTraffic added in v0.2.0 

func (o DeploymentCanarySettingsOutput) PercentTraffic() pulumi.Float64PtrOutput

The percentage (0.0-100.0) of traffic routed to the canary deployment.

func (DeploymentCanarySettingsOutput) StageVariableOverrides added in v0.2.0 

func (o DeploymentCanarySettingsOutput) StageVariableOverrides() pulumi.StringMapOutput

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

func (DeploymentCanarySettingsOutput) ToDeploymentCanarySettingsOutput added in v0.2.0 

func (o DeploymentCanarySettingsOutput) ToDeploymentCanarySettingsOutput() DeploymentCanarySettingsOutput

func (DeploymentCanarySettingsOutput) ToDeploymentCanarySettingsOutputWithContext added in v0.2.0 

func (o DeploymentCanarySettingsOutput) ToDeploymentCanarySettingsOutputWithContext(ctx context.Context) DeploymentCanarySettingsOutput

func (DeploymentCanarySettingsOutput) ToDeploymentCanarySettingsPtrOutput added in v0.2.0 

func (o DeploymentCanarySettingsOutput) ToDeploymentCanarySettingsPtrOutput() DeploymentCanarySettingsPtrOutput

func (DeploymentCanarySettingsOutput) ToDeploymentCanarySettingsPtrOutputWithContext added in v0.2.0 

func (o DeploymentCanarySettingsOutput) ToDeploymentCanarySettingsPtrOutputWithContext(ctx context.Context) DeploymentCanarySettingsPtrOutput

func (DeploymentCanarySettingsOutput) UseStageCache added in v0.2.0 

func (o DeploymentCanarySettingsOutput) UseStageCache() pulumi.BoolPtrOutput

A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

type DeploymentCanarySettingsPtrInput added in v0.2.0 

type DeploymentCanarySettingsPtrInput interface {
	pulumi.Input

	ToDeploymentCanarySettingsPtrOutput() DeploymentCanarySettingsPtrOutput
	ToDeploymentCanarySettingsPtrOutputWithContext(context.Context) DeploymentCanarySettingsPtrOutput
}

DeploymentCanarySettingsPtrInput is an input type that accepts DeploymentCanarySettingsArgs, DeploymentCanarySettingsPtr and DeploymentCanarySettingsPtrOutput values. You can construct a concrete instance of `DeploymentCanarySettingsPtrInput` via: 

        DeploymentCanarySettingsArgs{...}

or:

        nil

func DeploymentCanarySettingsPtr added in v0.2.0 

func DeploymentCanarySettingsPtr(v *DeploymentCanarySettingsArgs) DeploymentCanarySettingsPtrInput

type DeploymentCanarySettingsPtrOutput added in v0.2.0 

type DeploymentCanarySettingsPtrOutput struct{ *pulumi.OutputState }

func (DeploymentCanarySettingsPtrOutput) Elem added in v0.2.0 

func (o DeploymentCanarySettingsPtrOutput) Elem() DeploymentCanarySettingsOutput

func (DeploymentCanarySettingsPtrOutput) ElementType added in v0.2.0 

func (DeploymentCanarySettingsPtrOutput) ElementType() reflect.Type

func (DeploymentCanarySettingsPtrOutput) PercentTraffic added in v0.2.0 

func (o DeploymentCanarySettingsPtrOutput) PercentTraffic() pulumi.Float64PtrOutput

The percentage (0.0-100.0) of traffic routed to the canary deployment.

func (DeploymentCanarySettingsPtrOutput) StageVariableOverrides added in v0.2.0 

func (o DeploymentCanarySettingsPtrOutput) StageVariableOverrides() pulumi.StringMapOutput

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

func (DeploymentCanarySettingsPtrOutput) ToDeploymentCanarySettingsPtrOutput added in v0.2.0 

func (o DeploymentCanarySettingsPtrOutput) ToDeploymentCanarySettingsPtrOutput() DeploymentCanarySettingsPtrOutput

func (DeploymentCanarySettingsPtrOutput) ToDeploymentCanarySettingsPtrOutputWithContext added in v0.2.0 

func (o DeploymentCanarySettingsPtrOutput) ToDeploymentCanarySettingsPtrOutputWithContext(ctx context.Context) DeploymentCanarySettingsPtrOutput

func (DeploymentCanarySettingsPtrOutput) UseStageCache added in v0.2.0 

func (o DeploymentCanarySettingsPtrOutput) UseStageCache() pulumi.BoolPtrOutput

A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

type DeploymentInput 

type DeploymentInput interface {
	pulumi.Input

	ToDeploymentOutput() DeploymentOutput
	ToDeploymentOutputWithContext(ctx context.Context) DeploymentOutput
}

type DeploymentMethodSetting 

type DeploymentMethodSetting 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 affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
	DataTraceEnabled *bool `pulumi:"dataTraceEnabled"`
	// The HTTP method.
	HttpMethod *string `pulumi:"httpMethod"`
	// Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are “OFF“, “ERROR“, and “INFO“. Choose “ERROR“ to write only error-level entries to CloudWatch Logs, or choose “INFO“ to include all “ERROR“ events as well as extra informational events.
	LoggingLevel *string `pulumi:"loggingLevel"`
	// Specifies whether Amazon CloudWatch metrics are enabled for this method.
	MetricsEnabled *bool `pulumi:"metricsEnabled"`
	// The resource path for this method. Forward slashes (“/“) are encoded as “~1“ and the initial slash must include a forward slash. For example, the path value “/resource/subresource“ must be encoded as “/~1resource~1subresource“. To specify the root path, use only a slash (“/“).
	ResourcePath *string `pulumi:"resourcePath"`
	// Specifies the throttling burst limit.
	ThrottlingBurstLimit *int `pulumi:"throttlingBurstLimit"`
	// Specifies the throttling rate limit.
	ThrottlingRateLimit *float64 `pulumi:"throttlingRateLimit"`
}

The “MethodSetting“ property type configures settings for all methods in a stage. 

The ``MethodSettings`` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of ``MethodSetting`` property types.

type DeploymentMethodSettingArgs 

type DeploymentMethodSettingArgs 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 affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
	DataTraceEnabled pulumi.BoolPtrInput `pulumi:"dataTraceEnabled"`
	// The HTTP method.
	HttpMethod pulumi.StringPtrInput `pulumi:"httpMethod"`
	// Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are “OFF“, “ERROR“, and “INFO“. Choose “ERROR“ to write only error-level entries to CloudWatch Logs, or choose “INFO“ to include all “ERROR“ events as well as extra informational events.
	LoggingLevel pulumi.StringPtrInput `pulumi:"loggingLevel"`
	// Specifies whether Amazon CloudWatch metrics are enabled for this method.
	MetricsEnabled pulumi.BoolPtrInput `pulumi:"metricsEnabled"`
	// The resource path for this method. Forward slashes (“/“) are encoded as “~1“ and the initial slash must include a forward slash. For example, the path value “/resource/subresource“ must be encoded as “/~1resource~1subresource“. To specify the root path, use only a slash (“/“).
	ResourcePath pulumi.StringPtrInput `pulumi:"resourcePath"`
	// Specifies the throttling burst limit.
	ThrottlingBurstLimit pulumi.IntPtrInput `pulumi:"throttlingBurstLimit"`
	// Specifies the throttling rate limit.
	ThrottlingRateLimit pulumi.Float64PtrInput `pulumi:"throttlingRateLimit"`
}

The “MethodSetting“ property type configures settings for all methods in a stage. 

The ``MethodSettings`` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of ``MethodSetting`` property types.

func (DeploymentMethodSettingArgs) ElementType 

func (DeploymentMethodSettingArgs) ElementType() reflect.Type

func (DeploymentMethodSettingArgs) ToDeploymentMethodSettingOutput 

func (i DeploymentMethodSettingArgs) ToDeploymentMethodSettingOutput() DeploymentMethodSettingOutput

func (DeploymentMethodSettingArgs) ToDeploymentMethodSettingOutputWithContext 

func (i DeploymentMethodSettingArgs) ToDeploymentMethodSettingOutputWithContext(ctx context.Context) DeploymentMethodSettingOutput

type DeploymentMethodSettingArray 

type DeploymentMethodSettingArray []DeploymentMethodSettingInput

func (DeploymentMethodSettingArray) ElementType 

func (DeploymentMethodSettingArray) ElementType() reflect.Type

func (DeploymentMethodSettingArray) ToDeploymentMethodSettingArrayOutput 

func (i DeploymentMethodSettingArray) ToDeploymentMethodSettingArrayOutput() DeploymentMethodSettingArrayOutput

func (DeploymentMethodSettingArray) ToDeploymentMethodSettingArrayOutputWithContext 

func (i DeploymentMethodSettingArray) ToDeploymentMethodSettingArrayOutputWithContext(ctx context.Context) DeploymentMethodSettingArrayOutput

type DeploymentMethodSettingArrayInput 

type DeploymentMethodSettingArrayInput interface {
	pulumi.Input

	ToDeploymentMethodSettingArrayOutput() DeploymentMethodSettingArrayOutput
	ToDeploymentMethodSettingArrayOutputWithContext(context.Context) DeploymentMethodSettingArrayOutput
}

DeploymentMethodSettingArrayInput is an input type that accepts DeploymentMethodSettingArray and DeploymentMethodSettingArrayOutput values. You can construct a concrete instance of `DeploymentMethodSettingArrayInput` via: 

DeploymentMethodSettingArray{ DeploymentMethodSettingArgs{...} }

type DeploymentMethodSettingArrayOutput 

type DeploymentMethodSettingArrayOutput struct{ *pulumi.OutputState }

func (DeploymentMethodSettingArrayOutput) ElementType 

func (DeploymentMethodSettingArrayOutput) ElementType() reflect.Type

func (DeploymentMethodSettingArrayOutput) Index 

func (o DeploymentMethodSettingArrayOutput) Index(i pulumi.IntInput) DeploymentMethodSettingOutput

func (DeploymentMethodSettingArrayOutput) ToDeploymentMethodSettingArrayOutput 

func (o DeploymentMethodSettingArrayOutput) ToDeploymentMethodSettingArrayOutput() DeploymentMethodSettingArrayOutput

func (DeploymentMethodSettingArrayOutput) ToDeploymentMethodSettingArrayOutputWithContext 

func (o DeploymentMethodSettingArrayOutput) ToDeploymentMethodSettingArrayOutputWithContext(ctx context.Context) DeploymentMethodSettingArrayOutput

type DeploymentMethodSettingInput 

type DeploymentMethodSettingInput interface {
	pulumi.Input

	ToDeploymentMethodSettingOutput() DeploymentMethodSettingOutput
	ToDeploymentMethodSettingOutputWithContext(context.Context) DeploymentMethodSettingOutput
}

DeploymentMethodSettingInput is an input type that accepts DeploymentMethodSettingArgs and DeploymentMethodSettingOutput values. You can construct a concrete instance of `DeploymentMethodSettingInput` via: 

DeploymentMethodSettingArgs{...}

type DeploymentMethodSettingOutput 

type DeploymentMethodSettingOutput struct{ *pulumi.OutputState }

The “MethodSetting“ property type configures settings for all methods in a stage. 

The ``MethodSettings`` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of ``MethodSetting`` property types.

func (DeploymentMethodSettingOutput) CacheDataEncrypted 

func (o DeploymentMethodSettingOutput) CacheDataEncrypted() pulumi.BoolPtrOutput

Specifies whether the cached responses are encrypted.

func (DeploymentMethodSettingOutput) CacheTtlInSeconds 

func (o DeploymentMethodSettingOutput) 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 (DeploymentMethodSettingOutput) CachingEnabled 

func (o DeploymentMethodSettingOutput) 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 (DeploymentMethodSettingOutput) DataTraceEnabled 

func (o DeploymentMethodSettingOutput) DataTraceEnabled() pulumi.BoolPtrOutput

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.

func (DeploymentMethodSettingOutput) ElementType 

func (DeploymentMethodSettingOutput) ElementType() reflect.Type

func (DeploymentMethodSettingOutput) HttpMethod 

func (o DeploymentMethodSettingOutput) HttpMethod() pulumi.StringPtrOutput

The HTTP method.

func (DeploymentMethodSettingOutput) LoggingLevel 

func (o DeploymentMethodSettingOutput) LoggingLevel() pulumi.StringPtrOutput

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are “OFF“, “ERROR“, and “INFO“. Choose “ERROR“ to write only error-level entries to CloudWatch Logs, or choose “INFO“ to include all “ERROR“ events as well as extra informational events.

func (DeploymentMethodSettingOutput) MetricsEnabled 

func (o DeploymentMethodSettingOutput) MetricsEnabled() pulumi.BoolPtrOutput

Specifies whether Amazon CloudWatch metrics are enabled for this method.

func (DeploymentMethodSettingOutput) ResourcePath 

func (o DeploymentMethodSettingOutput) ResourcePath() pulumi.StringPtrOutput

The resource path for this method. Forward slashes (“/“) are encoded as “~1“ and the initial slash must include a forward slash. For example, the path value “/resource/subresource“ must be encoded as “/~1resource~1subresource“. To specify the root path, use only a slash (“/“).

func (DeploymentMethodSettingOutput) ThrottlingBurstLimit 

func (o DeploymentMethodSettingOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

Specifies the throttling burst limit.

func (DeploymentMethodSettingOutput) ThrottlingRateLimit 

func (o DeploymentMethodSettingOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput

Specifies the throttling rate limit.

func (DeploymentMethodSettingOutput) ToDeploymentMethodSettingOutput 

func (o DeploymentMethodSettingOutput) ToDeploymentMethodSettingOutput() DeploymentMethodSettingOutput

func (DeploymentMethodSettingOutput) ToDeploymentMethodSettingOutputWithContext 

func (o DeploymentMethodSettingOutput) ToDeploymentMethodSettingOutputWithContext(ctx context.Context) DeploymentMethodSettingOutput

type DeploymentOutput 

type DeploymentOutput struct{ *pulumi.OutputState }

func (DeploymentOutput) DeploymentCanarySettings added in v0.17.0 

func (o DeploymentOutput) DeploymentCanarySettings() DeploymentCanarySettingsPtrOutput

The input configuration for a canary deployment.

func (DeploymentOutput) DeploymentId added in v0.17.0 

func (o DeploymentOutput) DeploymentId() pulumi.StringOutput

func (DeploymentOutput) Description added in v0.17.0 

func (o DeploymentOutput) Description() pulumi.StringPtrOutput

The description for the Deployment resource to create.

func (DeploymentOutput) ElementType 

func (DeploymentOutput) ElementType() reflect.Type

func (DeploymentOutput) RestApiId added in v0.17.0 

func (o DeploymentOutput) RestApiId() pulumi.StringOutput

The string identifier of the associated RestApi.

func (DeploymentOutput) StageDescription added in v0.17.0 

func (o DeploymentOutput) StageDescription() DeploymentStageDescriptionPtrOutput

The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.

func (DeploymentOutput) StageName added in v0.17.0 

func (o DeploymentOutput) StageName() pulumi.StringPtrOutput

The name of the Stage resource for the Deployment resource to create.

func (DeploymentOutput) ToDeploymentOutput 

func (o DeploymentOutput) ToDeploymentOutput() DeploymentOutput

func (DeploymentOutput) ToDeploymentOutputWithContext 

func (o DeploymentOutput) ToDeploymentOutputWithContext(ctx context.Context) DeploymentOutput

type DeploymentStageDescription 

type DeploymentStageDescription struct {
	// Specifies settings for logging access in this stage.
	AccessLogSetting *DeploymentAccessLogSetting `pulumi:"accessLogSetting"`
	// Specifies whether a cache cluster is enabled for the stage.
	CacheClusterEnabled *bool `pulumi:"cacheClusterEnabled"`
	// The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*.
	CacheClusterSize *string `pulumi:"cacheClusterSize"`
	// Indicates whether the cached responses are encrypted.
	CacheDataEncrypted *bool `pulumi:"cacheDataEncrypted"`
	// The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
	CacheTtlInSeconds *int `pulumi:"cacheTtlInSeconds"`
	// Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*.
	CachingEnabled *bool `pulumi:"cachingEnabled"`
	// Specifies settings for the canary deployment in this stage.
	CanarySetting *DeploymentCanarySetting `pulumi:"canarySetting"`
	// The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
	ClientCertificateId *string `pulumi:"clientCertificateId"`
	// Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
	DataTraceEnabled *bool `pulumi:"dataTraceEnabled"`
	// A description of the purpose of the stage.
	Description *string `pulumi:"description"`
	// The version identifier of the API documentation snapshot.
	DocumentationVersion *string `pulumi:"documentationVersion"`
	// The logging level for this method. For valid values, see the “loggingLevel“ property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*.
	LoggingLevel *string `pulumi:"loggingLevel"`
	// Configures settings for all of the stage's methods.
	MethodSettings []DeploymentMethodSetting `pulumi:"methodSettings"`
	// Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
	MetricsEnabled *bool `pulumi:"metricsEnabled"`
	// An array of arbitrary tags (key-value pairs) to associate with the stage.
	Tags []DeploymentTag `pulumi:"tags"`
	// The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.
	ThrottlingBurstLimit *int `pulumi:"throttlingBurstLimit"`
	// The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.
	ThrottlingRateLimit *float64 `pulumi:"throttlingRateLimit"`
	// Specifies whether active tracing with X-ray is enabled for this stage.
	//  For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*.
	TracingEnabled *bool `pulumi:"tracingEnabled"`
	// A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: “[A-Za-z0-9-._~:/?#&=,]+“.
	Variables map[string]string `pulumi:"variables"`
}

“StageDescription“ is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.

type DeploymentStageDescriptionArgs 

type DeploymentStageDescriptionArgs struct {
	// Specifies settings for logging access in this stage.
	AccessLogSetting DeploymentAccessLogSettingPtrInput `pulumi:"accessLogSetting"`
	// Specifies whether a cache cluster is enabled for the stage.
	CacheClusterEnabled pulumi.BoolPtrInput `pulumi:"cacheClusterEnabled"`
	// The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*.
	CacheClusterSize pulumi.StringPtrInput `pulumi:"cacheClusterSize"`
	// Indicates whether the cached responses are encrypted.
	CacheDataEncrypted pulumi.BoolPtrInput `pulumi:"cacheDataEncrypted"`
	// The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
	CacheTtlInSeconds pulumi.IntPtrInput `pulumi:"cacheTtlInSeconds"`
	// Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*.
	CachingEnabled pulumi.BoolPtrInput `pulumi:"cachingEnabled"`
	// Specifies settings for the canary deployment in this stage.
	CanarySetting DeploymentCanarySettingPtrInput `pulumi:"canarySetting"`
	// The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
	ClientCertificateId pulumi.StringPtrInput `pulumi:"clientCertificateId"`
	// Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
	DataTraceEnabled pulumi.BoolPtrInput `pulumi:"dataTraceEnabled"`
	// A description of the purpose of the stage.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// The version identifier of the API documentation snapshot.
	DocumentationVersion pulumi.StringPtrInput `pulumi:"documentationVersion"`
	// The logging level for this method. For valid values, see the “loggingLevel“ property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*.
	LoggingLevel pulumi.StringPtrInput `pulumi:"loggingLevel"`
	// Configures settings for all of the stage's methods.
	MethodSettings DeploymentMethodSettingArrayInput `pulumi:"methodSettings"`
	// Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
	MetricsEnabled pulumi.BoolPtrInput `pulumi:"metricsEnabled"`
	// An array of arbitrary tags (key-value pairs) to associate with the stage.
	Tags DeploymentTagArrayInput `pulumi:"tags"`
	// The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.
	ThrottlingBurstLimit pulumi.IntPtrInput `pulumi:"throttlingBurstLimit"`
	// The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.
	ThrottlingRateLimit pulumi.Float64PtrInput `pulumi:"throttlingRateLimit"`
	// Specifies whether active tracing with X-ray is enabled for this stage.
	//  For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*.
	TracingEnabled pulumi.BoolPtrInput `pulumi:"tracingEnabled"`
	// A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: “[A-Za-z0-9-._~:/?#&=,]+“.
	Variables pulumi.StringMapInput `pulumi:"variables"`
}

“StageDescription“ is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.

func (DeploymentStageDescriptionArgs) ElementType 

func (DeploymentStageDescriptionArgs) ElementType() reflect.Type

func (DeploymentStageDescriptionArgs) ToDeploymentStageDescriptionOutput 

func (i DeploymentStageDescriptionArgs) ToDeploymentStageDescriptionOutput() DeploymentStageDescriptionOutput

func (DeploymentStageDescriptionArgs) ToDeploymentStageDescriptionOutputWithContext 

func (i DeploymentStageDescriptionArgs) ToDeploymentStageDescriptionOutputWithContext(ctx context.Context) DeploymentStageDescriptionOutput

func (DeploymentStageDescriptionArgs) ToDeploymentStageDescriptionPtrOutput 

func (i DeploymentStageDescriptionArgs) ToDeploymentStageDescriptionPtrOutput() DeploymentStageDescriptionPtrOutput

func (DeploymentStageDescriptionArgs) ToDeploymentStageDescriptionPtrOutputWithContext 

func (i DeploymentStageDescriptionArgs) ToDeploymentStageDescriptionPtrOutputWithContext(ctx context.Context) DeploymentStageDescriptionPtrOutput

type DeploymentStageDescriptionInput 

type DeploymentStageDescriptionInput interface {
	pulumi.Input

	ToDeploymentStageDescriptionOutput() DeploymentStageDescriptionOutput
	ToDeploymentStageDescriptionOutputWithContext(context.Context) DeploymentStageDescriptionOutput
}

DeploymentStageDescriptionInput is an input type that accepts DeploymentStageDescriptionArgs and DeploymentStageDescriptionOutput values. You can construct a concrete instance of `DeploymentStageDescriptionInput` via: 

DeploymentStageDescriptionArgs{...}

type DeploymentStageDescriptionOutput 

type DeploymentStageDescriptionOutput struct{ *pulumi.OutputState }

“StageDescription“ is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.

func (DeploymentStageDescriptionOutput) AccessLogSetting 

func (o DeploymentStageDescriptionOutput) AccessLogSetting() DeploymentAccessLogSettingPtrOutput

Specifies settings for logging access in this stage.

func (DeploymentStageDescriptionOutput) CacheClusterEnabled 

func (o DeploymentStageDescriptionOutput) CacheClusterEnabled() pulumi.BoolPtrOutput

Specifies whether a cache cluster is enabled for the stage.

func (DeploymentStageDescriptionOutput) CacheClusterSize 

func (o DeploymentStageDescriptionOutput) CacheClusterSize() pulumi.StringPtrOutput

The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*.

func (DeploymentStageDescriptionOutput) CacheDataEncrypted 

func (o DeploymentStageDescriptionOutput) CacheDataEncrypted() pulumi.BoolPtrOutput

Indicates whether the cached responses are encrypted.

func (DeploymentStageDescriptionOutput) CacheTtlInSeconds 

func (o DeploymentStageDescriptionOutput) CacheTtlInSeconds() pulumi.IntPtrOutput

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

func (DeploymentStageDescriptionOutput) CachingEnabled 

func (o DeploymentStageDescriptionOutput) CachingEnabled() pulumi.BoolPtrOutput

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*.

func (DeploymentStageDescriptionOutput) CanarySetting 

func (o DeploymentStageDescriptionOutput) CanarySetting() DeploymentCanarySettingPtrOutput

Specifies settings for the canary deployment in this stage.

func (DeploymentStageDescriptionOutput) ClientCertificateId 

func (o DeploymentStageDescriptionOutput) ClientCertificateId() pulumi.StringPtrOutput

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

func (DeploymentStageDescriptionOutput) DataTraceEnabled 

func (o DeploymentStageDescriptionOutput) DataTraceEnabled() pulumi.BoolPtrOutput

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

func (DeploymentStageDescriptionOutput) Description 

func (o DeploymentStageDescriptionOutput) Description() pulumi.StringPtrOutput

A description of the purpose of the stage.

func (DeploymentStageDescriptionOutput) DocumentationVersion 

func (o DeploymentStageDescriptionOutput) DocumentationVersion() pulumi.StringPtrOutput

The version identifier of the API documentation snapshot.

func (DeploymentStageDescriptionOutput) ElementType 

func (DeploymentStageDescriptionOutput) ElementType() reflect.Type

func (DeploymentStageDescriptionOutput) LoggingLevel 

func (o DeploymentStageDescriptionOutput) LoggingLevel() pulumi.StringPtrOutput

The logging level for this method. For valid values, see the “loggingLevel“ property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*.

func (DeploymentStageDescriptionOutput) MethodSettings 

func (o DeploymentStageDescriptionOutput) MethodSettings() DeploymentMethodSettingArrayOutput

Configures settings for all of the stage's methods.

func (DeploymentStageDescriptionOutput) MetricsEnabled 

func (o DeploymentStageDescriptionOutput) MetricsEnabled() pulumi.BoolPtrOutput

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

func (DeploymentStageDescriptionOutput) Tags 

func (o DeploymentStageDescriptionOutput) Tags() DeploymentTagArrayOutput

An array of arbitrary tags (key-value pairs) to associate with the stage.

func (DeploymentStageDescriptionOutput) ThrottlingBurstLimit 

func (o DeploymentStageDescriptionOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.

func (DeploymentStageDescriptionOutput) ThrottlingRateLimit 

func (o DeploymentStageDescriptionOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput

The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.

func (DeploymentStageDescriptionOutput) ToDeploymentStageDescriptionOutput 

func (o DeploymentStageDescriptionOutput) ToDeploymentStageDescriptionOutput() DeploymentStageDescriptionOutput

func (DeploymentStageDescriptionOutput) ToDeploymentStageDescriptionOutputWithContext 

func (o DeploymentStageDescriptionOutput) ToDeploymentStageDescriptionOutputWithContext(ctx context.Context) DeploymentStageDescriptionOutput

func (DeploymentStageDescriptionOutput) ToDeploymentStageDescriptionPtrOutput 

func (o DeploymentStageDescriptionOutput) ToDeploymentStageDescriptionPtrOutput() DeploymentStageDescriptionPtrOutput

func (DeploymentStageDescriptionOutput) ToDeploymentStageDescriptionPtrOutputWithContext 

func (o DeploymentStageDescriptionOutput) ToDeploymentStageDescriptionPtrOutputWithContext(ctx context.Context) DeploymentStageDescriptionPtrOutput

func (DeploymentStageDescriptionOutput) TracingEnabled 

func (o DeploymentStageDescriptionOutput) TracingEnabled() pulumi.BoolPtrOutput

Specifies whether active tracing with X-ray is enabled for this stage. 

For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*.

func (DeploymentStageDescriptionOutput) Variables 

func (o DeploymentStageDescriptionOutput) Variables() pulumi.StringMapOutput

A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: “[A-Za-z0-9-._~:/?#&=,]+“.

type DeploymentStageDescriptionPtrInput 

type DeploymentStageDescriptionPtrInput interface {
	pulumi.Input

	ToDeploymentStageDescriptionPtrOutput() DeploymentStageDescriptionPtrOutput
	ToDeploymentStageDescriptionPtrOutputWithContext(context.Context) DeploymentStageDescriptionPtrOutput
}

DeploymentStageDescriptionPtrInput is an input type that accepts DeploymentStageDescriptionArgs, DeploymentStageDescriptionPtr and DeploymentStageDescriptionPtrOutput values. You can construct a concrete instance of `DeploymentStageDescriptionPtrInput` via: 

        DeploymentStageDescriptionArgs{...}

or:

        nil

func DeploymentStageDescriptionPtr 

func DeploymentStageDescriptionPtr(v *DeploymentStageDescriptionArgs) DeploymentStageDescriptionPtrInput

type DeploymentStageDescriptionPtrOutput 

type DeploymentStageDescriptionPtrOutput struct{ *pulumi.OutputState }

func (DeploymentStageDescriptionPtrOutput) AccessLogSetting 

func (o DeploymentStageDescriptionPtrOutput) AccessLogSetting() DeploymentAccessLogSettingPtrOutput

Specifies settings for logging access in this stage.

func (DeploymentStageDescriptionPtrOutput) CacheClusterEnabled 

func (o DeploymentStageDescriptionPtrOutput) CacheClusterEnabled() pulumi.BoolPtrOutput

Specifies whether a cache cluster is enabled for the stage.

func (DeploymentStageDescriptionPtrOutput) CacheClusterSize 

func (o DeploymentStageDescriptionPtrOutput) CacheClusterSize() pulumi.StringPtrOutput

The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*.

func (DeploymentStageDescriptionPtrOutput) CacheDataEncrypted 

func (o DeploymentStageDescriptionPtrOutput) CacheDataEncrypted() pulumi.BoolPtrOutput

Indicates whether the cached responses are encrypted.

func (DeploymentStageDescriptionPtrOutput) CacheTtlInSeconds 

func (o DeploymentStageDescriptionPtrOutput) CacheTtlInSeconds() pulumi.IntPtrOutput

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

func (DeploymentStageDescriptionPtrOutput) CachingEnabled 

func (o DeploymentStageDescriptionPtrOutput) CachingEnabled() pulumi.BoolPtrOutput

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*.

func (DeploymentStageDescriptionPtrOutput) CanarySetting 

func (o DeploymentStageDescriptionPtrOutput) CanarySetting() DeploymentCanarySettingPtrOutput

Specifies settings for the canary deployment in this stage.

func (DeploymentStageDescriptionPtrOutput) ClientCertificateId 

func (o DeploymentStageDescriptionPtrOutput) ClientCertificateId() pulumi.StringPtrOutput

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

func (DeploymentStageDescriptionPtrOutput) DataTraceEnabled 

func (o DeploymentStageDescriptionPtrOutput) DataTraceEnabled() pulumi.BoolPtrOutput

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

func (DeploymentStageDescriptionPtrOutput) Description 

func (o DeploymentStageDescriptionPtrOutput) Description() pulumi.StringPtrOutput

A description of the purpose of the stage.

func (DeploymentStageDescriptionPtrOutput) DocumentationVersion 

func (o DeploymentStageDescriptionPtrOutput) DocumentationVersion() pulumi.StringPtrOutput

The version identifier of the API documentation snapshot.

func (DeploymentStageDescriptionPtrOutput) Elem 

func (o DeploymentStageDescriptionPtrOutput) Elem() DeploymentStageDescriptionOutput

func (DeploymentStageDescriptionPtrOutput) ElementType 

func (DeploymentStageDescriptionPtrOutput) ElementType() reflect.Type

func (DeploymentStageDescriptionPtrOutput) LoggingLevel 

func (o DeploymentStageDescriptionPtrOutput) LoggingLevel() pulumi.StringPtrOutput

The logging level for this method. For valid values, see the “loggingLevel“ property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*.

func (DeploymentStageDescriptionPtrOutput) MethodSettings 

func (o DeploymentStageDescriptionPtrOutput) MethodSettings() DeploymentMethodSettingArrayOutput

Configures settings for all of the stage's methods.

func (DeploymentStageDescriptionPtrOutput) MetricsEnabled 

func (o DeploymentStageDescriptionPtrOutput) MetricsEnabled() pulumi.BoolPtrOutput

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

func (DeploymentStageDescriptionPtrOutput) Tags 

func (o DeploymentStageDescriptionPtrOutput) Tags() DeploymentTagArrayOutput

An array of arbitrary tags (key-value pairs) to associate with the stage.

func (DeploymentStageDescriptionPtrOutput) ThrottlingBurstLimit 

func (o DeploymentStageDescriptionPtrOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.

func (DeploymentStageDescriptionPtrOutput) ThrottlingRateLimit 

func (o DeploymentStageDescriptionPtrOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput

The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.

func (DeploymentStageDescriptionPtrOutput) ToDeploymentStageDescriptionPtrOutput 

func (o DeploymentStageDescriptionPtrOutput) ToDeploymentStageDescriptionPtrOutput() DeploymentStageDescriptionPtrOutput

func (DeploymentStageDescriptionPtrOutput) ToDeploymentStageDescriptionPtrOutputWithContext 

func (o DeploymentStageDescriptionPtrOutput) ToDeploymentStageDescriptionPtrOutputWithContext(ctx context.Context) DeploymentStageDescriptionPtrOutput

func (DeploymentStageDescriptionPtrOutput) TracingEnabled 

func (o DeploymentStageDescriptionPtrOutput) TracingEnabled() pulumi.BoolPtrOutput

Specifies whether active tracing with X-ray is enabled for this stage. 

For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*.

func (DeploymentStageDescriptionPtrOutput) Variables 

func (o DeploymentStageDescriptionPtrOutput) Variables() pulumi.StringMapOutput

A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: “[A-Za-z0-9-._~:/?#&=,]+“.

type DeploymentState 

type DeploymentState struct {
}

func (DeploymentState) ElementType 

func (DeploymentState) ElementType() reflect.Type

type DeploymentTag 

type DeploymentTag struct {
	// The key name of the tag
	Key string `pulumi:"key"`
	// The value for the tag
	Value string `pulumi:"value"`
}

type DeploymentTagArgs 

type DeploymentTagArgs struct {
	// The key name of the tag
	Key pulumi.StringInput `pulumi:"key"`
	// The value for the tag
	Value pulumi.StringInput `pulumi:"value"`
}

func (DeploymentTagArgs) ElementType 

func (DeploymentTagArgs) ElementType() reflect.Type

func (DeploymentTagArgs) ToDeploymentTagOutput 

func (i DeploymentTagArgs) ToDeploymentTagOutput() DeploymentTagOutput

func (DeploymentTagArgs) ToDeploymentTagOutputWithContext 

func (i DeploymentTagArgs) ToDeploymentTagOutputWithContext(ctx context.Context) DeploymentTagOutput

type DeploymentTagArray 

type DeploymentTagArray []DeploymentTagInput

func (DeploymentTagArray) ElementType 

func (DeploymentTagArray) ElementType() reflect.Type

func (DeploymentTagArray) ToDeploymentTagArrayOutput 

func (i DeploymentTagArray) ToDeploymentTagArrayOutput() DeploymentTagArrayOutput

func (DeploymentTagArray) ToDeploymentTagArrayOutputWithContext 

func (i DeploymentTagArray) ToDeploymentTagArrayOutputWithContext(ctx context.Context) DeploymentTagArrayOutput

type DeploymentTagArrayInput 

type DeploymentTagArrayInput interface {
	pulumi.Input

	ToDeploymentTagArrayOutput() DeploymentTagArrayOutput
	ToDeploymentTagArrayOutputWithContext(context.Context) DeploymentTagArrayOutput
}

DeploymentTagArrayInput is an input type that accepts DeploymentTagArray and DeploymentTagArrayOutput values. You can construct a concrete instance of `DeploymentTagArrayInput` via: 

DeploymentTagArray{ DeploymentTagArgs{...} }

type DeploymentTagArrayOutput 

type DeploymentTagArrayOutput struct{ *pulumi.OutputState }

func (DeploymentTagArrayOutput) ElementType 

func (DeploymentTagArrayOutput) ElementType() reflect.Type

func (DeploymentTagArrayOutput) Index 

func (o DeploymentTagArrayOutput) Index(i pulumi.IntInput) DeploymentTagOutput

func (DeploymentTagArrayOutput) ToDeploymentTagArrayOutput 

func (o DeploymentTagArrayOutput) ToDeploymentTagArrayOutput() DeploymentTagArrayOutput

func (DeploymentTagArrayOutput) ToDeploymentTagArrayOutputWithContext 

func (o DeploymentTagArrayOutput) ToDeploymentTagArrayOutputWithContext(ctx context.Context) DeploymentTagArrayOutput

type DeploymentTagInput 

type DeploymentTagInput interface {
	pulumi.Input

	ToDeploymentTagOutput() DeploymentTagOutput
	ToDeploymentTagOutputWithContext(context.Context) DeploymentTagOutput
}

DeploymentTagInput is an input type that accepts DeploymentTagArgs and DeploymentTagOutput values. You can construct a concrete instance of `DeploymentTagInput` via: 

DeploymentTagArgs{...}

type DeploymentTagOutput 

type DeploymentTagOutput struct{ *pulumi.OutputState }

func (DeploymentTagOutput) ElementType 

func (DeploymentTagOutput) ElementType() reflect.Type

func (DeploymentTagOutput) Key 

func (o DeploymentTagOutput) Key() pulumi.StringOutput

The key name of the tag

func (DeploymentTagOutput) ToDeploymentTagOutput 

func (o DeploymentTagOutput) ToDeploymentTagOutput() DeploymentTagOutput

func (DeploymentTagOutput) ToDeploymentTagOutputWithContext 

func (o DeploymentTagOutput) ToDeploymentTagOutputWithContext(ctx context.Context) DeploymentTagOutput

func (DeploymentTagOutput) Value 

func (o DeploymentTagOutput) Value() pulumi.StringOutput

The value for the tag

type DocumentationPart 

type DocumentationPart struct {
	pulumi.CustomResourceState

	DocumentationPartId pulumi.StringOutput `pulumi:"documentationPartId"`
	// The location of the targeted API entity of the to-be-created documentation part.
	Location DocumentationPartLocationOutput `pulumi:"location"`
	// The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
	Properties pulumi.StringOutput `pulumi:"properties"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
}

The “AWS::ApiGateway::DocumentationPart“ resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.

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.

func (*DocumentationPart) ElementType 

func (*DocumentationPart) ElementType() reflect.Type

func (*DocumentationPart) ToDocumentationPartOutput 

func (i *DocumentationPart) ToDocumentationPartOutput() DocumentationPartOutput

func (*DocumentationPart) ToDocumentationPartOutputWithContext 

func (i *DocumentationPart) ToDocumentationPartOutputWithContext(ctx context.Context) DocumentationPartOutput

type DocumentationPartArgs 

type DocumentationPartArgs struct {
	// The location of the targeted API entity of the to-be-created documentation part.
	Location DocumentationPartLocationInput
	// The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
	Properties pulumi.StringInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput
}

The set of arguments for constructing a DocumentationPart resource.

func (DocumentationPartArgs) ElementType 

func (DocumentationPartArgs) ElementType() reflect.Type

type DocumentationPartInput 

type DocumentationPartInput interface {
	pulumi.Input

	ToDocumentationPartOutput() DocumentationPartOutput
	ToDocumentationPartOutputWithContext(ctx context.Context) DocumentationPartOutput
}

type DocumentationPartLocation 

type DocumentationPartLocation struct {
	// The HTTP verb of a method. It is a valid field for the API entity types of “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. The default value is “*“ for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other “location“ attributes, the child entity's “method“ attribute must match that of the parent entity exactly.
	Method *string `pulumi:"method"`
	// The name of the targeted API entity. It is a valid and required field for the API entity types of “AUTHORIZER“, “MODEL“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“ and “RESPONSE_HEADER“. It is an invalid field for any other entity type.
	Name *string `pulumi:"name"`
	// The URL path of the target. It is a valid field for the API entity types of “RESOURCE“, “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. The default value is “/“ for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other “location“ attributes, the child entity's “path“ attribute must match that of the parent entity as a prefix.
	Path *string `pulumi:"path"`
	// The HTTP status code of a response. It is a valid field for the API entity types of “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. The default value is “*“ for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other “location“ attributes, the child entity's “statusCode“ attribute must match that of the parent entity exactly.
	StatusCode *string `pulumi:"statusCode"`
	// The type of API entity to which the documentation content applies. Valid values are “API“, “AUTHORIZER“, “MODEL“, “RESOURCE“, “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. Content inheritance does not apply to any entity of the “API“, “AUTHORIZER“, “METHOD“, “MODEL“, “REQUEST_BODY“, or “RESOURCE“ type.
	Type *DocumentationPartLocationType `pulumi:"type"`
}

The “Location“ property specifies the location of the Amazon API Gateway API entity that the documentation applies to. “Location“ is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource. 

For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.

type DocumentationPartLocationArgs 

type DocumentationPartLocationArgs struct {
	// The HTTP verb of a method. It is a valid field for the API entity types of “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. The default value is “*“ for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other “location“ attributes, the child entity's “method“ attribute must match that of the parent entity exactly.
	Method pulumi.StringPtrInput `pulumi:"method"`
	// The name of the targeted API entity. It is a valid and required field for the API entity types of “AUTHORIZER“, “MODEL“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“ and “RESPONSE_HEADER“. It is an invalid field for any other entity type.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The URL path of the target. It is a valid field for the API entity types of “RESOURCE“, “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. The default value is “/“ for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other “location“ attributes, the child entity's “path“ attribute must match that of the parent entity as a prefix.
	Path pulumi.StringPtrInput `pulumi:"path"`
	// The HTTP status code of a response. It is a valid field for the API entity types of “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. The default value is “*“ for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other “location“ attributes, the child entity's “statusCode“ attribute must match that of the parent entity exactly.
	StatusCode pulumi.StringPtrInput `pulumi:"statusCode"`
	// The type of API entity to which the documentation content applies. Valid values are “API“, “AUTHORIZER“, “MODEL“, “RESOURCE“, “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. Content inheritance does not apply to any entity of the “API“, “AUTHORIZER“, “METHOD“, “MODEL“, “REQUEST_BODY“, or “RESOURCE“ type.
	Type DocumentationPartLocationTypePtrInput `pulumi:"type"`
}

The “Location“ property specifies the location of the Amazon API Gateway API entity that the documentation applies to. “Location“ is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource. 

For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.

func (DocumentationPartLocationArgs) ElementType 

func (DocumentationPartLocationArgs) ElementType() reflect.Type

func (DocumentationPartLocationArgs) ToDocumentationPartLocationOutput 

func (i DocumentationPartLocationArgs) ToDocumentationPartLocationOutput() DocumentationPartLocationOutput

func (DocumentationPartLocationArgs) ToDocumentationPartLocationOutputWithContext 

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

type DocumentationPartLocationInput 

type DocumentationPartLocationInput interface {
	pulumi.Input

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

DocumentationPartLocationInput is an input type that accepts DocumentationPartLocationArgs and DocumentationPartLocationOutput values. You can construct a concrete instance of `DocumentationPartLocationInput` via: 

DocumentationPartLocationArgs{...}

type DocumentationPartLocationOutput 

type DocumentationPartLocationOutput struct{ *pulumi.OutputState }

The “Location“ property specifies the location of the Amazon API Gateway API entity that the documentation applies to. “Location“ is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource. 

For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.

func (DocumentationPartLocationOutput) ElementType 

func (DocumentationPartLocationOutput) ElementType() reflect.Type

func (DocumentationPartLocationOutput) Method 

func (o DocumentationPartLocationOutput) Method() pulumi.StringPtrOutput

The HTTP verb of a method. It is a valid field for the API entity types of “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. The default value is “*“ for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other “location“ attributes, the child entity's “method“ attribute must match that of the parent entity exactly.

func (DocumentationPartLocationOutput) Name 

func (o DocumentationPartLocationOutput) Name() pulumi.StringPtrOutput

The name of the targeted API entity. It is a valid and required field for the API entity types of “AUTHORIZER“, “MODEL“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“ and “RESPONSE_HEADER“. It is an invalid field for any other entity type.

func (DocumentationPartLocationOutput) Path 

func (o DocumentationPartLocationOutput) Path() pulumi.StringPtrOutput

The URL path of the target. It is a valid field for the API entity types of “RESOURCE“, “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. The default value is “/“ for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other “location“ attributes, the child entity's “path“ attribute must match that of the parent entity as a prefix.

func (DocumentationPartLocationOutput) StatusCode 

func (o DocumentationPartLocationOutput) StatusCode() pulumi.StringPtrOutput

The HTTP status code of a response. It is a valid field for the API entity types of “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. The default value is “*“ for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other “location“ attributes, the child entity's “statusCode“ attribute must match that of the parent entity exactly.

func (DocumentationPartLocationOutput) ToDocumentationPartLocationOutput 

func (o DocumentationPartLocationOutput) ToDocumentationPartLocationOutput() DocumentationPartLocationOutput

func (DocumentationPartLocationOutput) ToDocumentationPartLocationOutputWithContext 

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

func (DocumentationPartLocationOutput) Type 

func (o DocumentationPartLocationOutput) Type() DocumentationPartLocationTypePtrOutput

The type of API entity to which the documentation content applies. Valid values are “API“, “AUTHORIZER“, “MODEL“, “RESOURCE“, “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. Content inheritance does not apply to any entity of the “API“, “AUTHORIZER“, “METHOD“, “MODEL“, “REQUEST_BODY“, or “RESOURCE“ type.

type DocumentationPartLocationType added in v0.21.0 

type DocumentationPartLocationType string

The type of API entity to which the documentation content applies. Valid values are “API“, “AUTHORIZER“, “MODEL“, “RESOURCE“, “METHOD“, “PATH_PARAMETER“, “QUERY_PARAMETER“, “REQUEST_HEADER“, “REQUEST_BODY“, “RESPONSE“, “RESPONSE_HEADER“, and “RESPONSE_BODY“. Content inheritance does not apply to any entity of the “API“, “AUTHORIZER“, “METHOD“, “MODEL“, “REQUEST_BODY“, or “RESOURCE“ type.

func (DocumentationPartLocationType) ElementType added in v0.21.0 

func (DocumentationPartLocationType) ElementType() reflect.Type

func (DocumentationPartLocationType) ToDocumentationPartLocationTypeOutput added in v0.21.0 

func (e DocumentationPartLocationType) ToDocumentationPartLocationTypeOutput() DocumentationPartLocationTypeOutput

func (DocumentationPartLocationType) ToDocumentationPartLocationTypeOutputWithContext added in v0.21.0 

func (e DocumentationPartLocationType) ToDocumentationPartLocationTypeOutputWithContext(ctx context.Context) DocumentationPartLocationTypeOutput

func (DocumentationPartLocationType) ToDocumentationPartLocationTypePtrOutput added in v0.21.0 

func (e DocumentationPartLocationType) ToDocumentationPartLocationTypePtrOutput() DocumentationPartLocationTypePtrOutput

func (DocumentationPartLocationType) ToDocumentationPartLocationTypePtrOutputWithContext added in v0.21.0 

func (e DocumentationPartLocationType) ToDocumentationPartLocationTypePtrOutputWithContext(ctx context.Context) DocumentationPartLocationTypePtrOutput

func (DocumentationPartLocationType) ToStringOutput added in v0.21.0 

func (e DocumentationPartLocationType) ToStringOutput() pulumi.StringOutput

func (DocumentationPartLocationType) ToStringOutputWithContext added in v0.21.0 

func (e DocumentationPartLocationType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DocumentationPartLocationType) ToStringPtrOutput added in v0.21.0 

func (e DocumentationPartLocationType) ToStringPtrOutput() pulumi.StringPtrOutput

func (DocumentationPartLocationType) ToStringPtrOutputWithContext added in v0.21.0 

func (e DocumentationPartLocationType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DocumentationPartLocationTypeInput added in v0.21.0 

type DocumentationPartLocationTypeInput interface {
	pulumi.Input

	ToDocumentationPartLocationTypeOutput() DocumentationPartLocationTypeOutput
	ToDocumentationPartLocationTypeOutputWithContext(context.Context) DocumentationPartLocationTypeOutput
}

DocumentationPartLocationTypeInput is an input type that accepts values of the DocumentationPartLocationType enum A concrete instance of `DocumentationPartLocationTypeInput` can be one of the following: 

DocumentationPartLocationTypeApi
DocumentationPartLocationTypeAuthorizer
DocumentationPartLocationTypeModel
DocumentationPartLocationTypeResource
DocumentationPartLocationTypeMethod
DocumentationPartLocationTypePathParameter
DocumentationPartLocationTypeQueryParameter
DocumentationPartLocationTypeRequestHeader
DocumentationPartLocationTypeRequestBody
DocumentationPartLocationTypeResponse
DocumentationPartLocationTypeResponseHeader
DocumentationPartLocationTypeResponseBody

type DocumentationPartLocationTypeOutput added in v0.21.0 

type DocumentationPartLocationTypeOutput struct{ *pulumi.OutputState }

func (DocumentationPartLocationTypeOutput) ElementType added in v0.21.0 

func (DocumentationPartLocationTypeOutput) ElementType() reflect.Type

func (DocumentationPartLocationTypeOutput) ToDocumentationPartLocationTypeOutput added in v0.21.0 

func (o DocumentationPartLocationTypeOutput) ToDocumentationPartLocationTypeOutput() DocumentationPartLocationTypeOutput

func (DocumentationPartLocationTypeOutput) ToDocumentationPartLocationTypeOutputWithContext added in v0.21.0 

func (o DocumentationPartLocationTypeOutput) ToDocumentationPartLocationTypeOutputWithContext(ctx context.Context) DocumentationPartLocationTypeOutput

func (DocumentationPartLocationTypeOutput) ToDocumentationPartLocationTypePtrOutput added in v0.21.0 

func (o DocumentationPartLocationTypeOutput) ToDocumentationPartLocationTypePtrOutput() DocumentationPartLocationTypePtrOutput

func (DocumentationPartLocationTypeOutput) ToDocumentationPartLocationTypePtrOutputWithContext added in v0.21.0 

func (o DocumentationPartLocationTypeOutput) ToDocumentationPartLocationTypePtrOutputWithContext(ctx context.Context) DocumentationPartLocationTypePtrOutput

func (DocumentationPartLocationTypeOutput) ToStringOutput added in v0.21.0 

func (o DocumentationPartLocationTypeOutput) ToStringOutput() pulumi.StringOutput

func (DocumentationPartLocationTypeOutput) ToStringOutputWithContext added in v0.21.0 

func (o DocumentationPartLocationTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DocumentationPartLocationTypeOutput) ToStringPtrOutput added in v0.21.0 

func (o DocumentationPartLocationTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DocumentationPartLocationTypeOutput) ToStringPtrOutputWithContext added in v0.21.0 

func (o DocumentationPartLocationTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DocumentationPartLocationTypePtrInput added in v0.21.0 

type DocumentationPartLocationTypePtrInput interface {
	pulumi.Input

	ToDocumentationPartLocationTypePtrOutput() DocumentationPartLocationTypePtrOutput
	ToDocumentationPartLocationTypePtrOutputWithContext(context.Context) DocumentationPartLocationTypePtrOutput
}

func DocumentationPartLocationTypePtr added in v0.21.0 

func DocumentationPartLocationTypePtr(v string) DocumentationPartLocationTypePtrInput

type DocumentationPartLocationTypePtrOutput added in v0.21.0 

type DocumentationPartLocationTypePtrOutput struct{ *pulumi.OutputState }

func (DocumentationPartLocationTypePtrOutput) Elem added in v0.21.0 

func (o DocumentationPartLocationTypePtrOutput) Elem() DocumentationPartLocationTypeOutput

func (DocumentationPartLocationTypePtrOutput) ElementType added in v0.21.0 

func (DocumentationPartLocationTypePtrOutput) ElementType() reflect.Type

func (DocumentationPartLocationTypePtrOutput) ToDocumentationPartLocationTypePtrOutput added in v0.21.0 

func (o DocumentationPartLocationTypePtrOutput) ToDocumentationPartLocationTypePtrOutput() DocumentationPartLocationTypePtrOutput

func (DocumentationPartLocationTypePtrOutput) ToDocumentationPartLocationTypePtrOutputWithContext added in v0.21.0 

func (o DocumentationPartLocationTypePtrOutput) ToDocumentationPartLocationTypePtrOutputWithContext(ctx context.Context) DocumentationPartLocationTypePtrOutput

func (DocumentationPartLocationTypePtrOutput) ToStringPtrOutput added in v0.21.0 

func (o DocumentationPartLocationTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DocumentationPartLocationTypePtrOutput) ToStringPtrOutputWithContext added in v0.21.0 

func (o DocumentationPartLocationTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DocumentationPartOutput 

type DocumentationPartOutput struct{ *pulumi.OutputState }

func (DocumentationPartOutput) DocumentationPartId added in v0.21.0 

func (o DocumentationPartOutput) DocumentationPartId() pulumi.StringOutput

func (DocumentationPartOutput) ElementType 

func (DocumentationPartOutput) ElementType() reflect.Type

func (DocumentationPartOutput) Location added in v0.17.0 

func (o DocumentationPartOutput) Location() DocumentationPartLocationOutput

The location of the targeted API entity of the to-be-created documentation part.

func (DocumentationPartOutput) Properties added in v0.17.0 

func (o DocumentationPartOutput) Properties() pulumi.StringOutput

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

func (DocumentationPartOutput) RestApiId added in v0.17.0 

func (o DocumentationPartOutput) RestApiId() pulumi.StringOutput

The string identifier of the associated RestApi.

func (DocumentationPartOutput) ToDocumentationPartOutput 

func (o DocumentationPartOutput) ToDocumentationPartOutput() DocumentationPartOutput

func (DocumentationPartOutput) ToDocumentationPartOutputWithContext 

func (o DocumentationPartOutput) ToDocumentationPartOutputWithContext(ctx context.Context) DocumentationPartOutput

type DocumentationPartState 

type DocumentationPartState struct {
}

func (DocumentationPartState) ElementType 

func (DocumentationPartState) ElementType() reflect.Type

type DocumentationVersion 

type DocumentationVersion struct {
	pulumi.CustomResourceState

	// A description about the new documentation snapshot.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The version identifier of the to-be-updated documentation version.
	DocumentationVersion pulumi.StringOutput `pulumi:"documentationVersion"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
}

The “AWS::ApiGateway::DocumentationVersion“ resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.

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.

func (*DocumentationVersion) ElementType 

func (*DocumentationVersion) ElementType() reflect.Type

func (*DocumentationVersion) ToDocumentationVersionOutput 

func (i *DocumentationVersion) ToDocumentationVersionOutput() DocumentationVersionOutput

func (*DocumentationVersion) ToDocumentationVersionOutputWithContext 

func (i *DocumentationVersion) ToDocumentationVersionOutputWithContext(ctx context.Context) DocumentationVersionOutput

type DocumentationVersionArgs 

type DocumentationVersionArgs struct {
	// A description about the new documentation snapshot.
	Description pulumi.StringPtrInput
	// The version identifier of the to-be-updated documentation version.
	DocumentationVersion pulumi.StringInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput
}

The set of arguments for constructing a DocumentationVersion resource.

func (DocumentationVersionArgs) ElementType 

func (DocumentationVersionArgs) ElementType() reflect.Type

type DocumentationVersionInput 

type DocumentationVersionInput interface {
	pulumi.Input

	ToDocumentationVersionOutput() DocumentationVersionOutput
	ToDocumentationVersionOutputWithContext(ctx context.Context) DocumentationVersionOutput
}

type DocumentationVersionOutput 

type DocumentationVersionOutput struct{ *pulumi.OutputState }

func (DocumentationVersionOutput) Description added in v0.17.0 

func (o DocumentationVersionOutput) Description() pulumi.StringPtrOutput

A description about the new documentation snapshot.

func (DocumentationVersionOutput) DocumentationVersion added in v0.17.0 

func (o DocumentationVersionOutput) DocumentationVersion() pulumi.StringOutput

The version identifier of the to-be-updated documentation version.

func (DocumentationVersionOutput) ElementType 

func (DocumentationVersionOutput) ElementType() reflect.Type

func (DocumentationVersionOutput) RestApiId added in v0.17.0 

func (o DocumentationVersionOutput) RestApiId() pulumi.StringOutput

The string identifier of the associated RestApi.

func (DocumentationVersionOutput) ToDocumentationVersionOutput 

func (o DocumentationVersionOutput) ToDocumentationVersionOutput() DocumentationVersionOutput

func (DocumentationVersionOutput) ToDocumentationVersionOutputWithContext 

func (o DocumentationVersionOutput) ToDocumentationVersionOutputWithContext(ctx context.Context) DocumentationVersionOutput

type DocumentationVersionState 

type DocumentationVersionState struct {
}

func (DocumentationVersionState) ElementType 

func (DocumentationVersionState) ElementType() reflect.Type

type DomainName 

type DomainName struct {
	pulumi.CustomResourceState

	CertificateArn                      pulumi.StringPtrOutput                     `pulumi:"certificateArn"`
	DistributionDomainName              pulumi.StringOutput                        `pulumi:"distributionDomainName"`
	DistributionHostedZoneId            pulumi.StringOutput                        `pulumi:"distributionHostedZoneId"`
	DomainName                          pulumi.StringPtrOutput                     `pulumi:"domainName"`
	EndpointConfiguration               DomainNameEndpointConfigurationPtrOutput   `pulumi:"endpointConfiguration"`
	MutualTlsAuthentication             DomainNameMutualTlsAuthenticationPtrOutput `pulumi:"mutualTlsAuthentication"`
	OwnershipVerificationCertificateArn pulumi.StringPtrOutput                     `pulumi:"ownershipVerificationCertificateArn"`
	RegionalCertificateArn              pulumi.StringPtrOutput                     `pulumi:"regionalCertificateArn"`
	RegionalDomainName                  pulumi.StringOutput                        `pulumi:"regionalDomainName"`
	RegionalHostedZoneId                pulumi.StringOutput                        `pulumi:"regionalHostedZoneId"`
	SecurityPolicy                      pulumi.StringPtrOutput                     `pulumi:"securityPolicy"`
	Tags                                aws.TagArrayOutput                         `pulumi:"tags"`
}

Resource Type definition for AWS::ApiGateway::DomainName.

## Example Usage ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		cfnDomainName := cfg.Require("cfnDomainName")
		certificateArn := cfg.Require("certificateArn")
		_type := cfg.Require("type")
		myDomainName, err := apigateway.NewDomainName(ctx, "myDomainName", &apigateway.DomainNameArgs{
			CertificateArn: pulumi.String(certificateArn),
			DomainName:     pulumi.String(cfnDomainName),
			EndpointConfiguration: &apigateway.DomainNameEndpointConfigurationArgs{
				Types: pulumi.StringArray{
					pulumi.String(_type),
				},
			},
			RegionalCertificateArn: pulumi.String(certificateArn),
		})
		if err != nil {
			return err
		}
		ctx.Export("domainName", myDomainName.ID())
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		cfnDomainName := cfg.Require("cfnDomainName")
		certificateArn := cfg.Require("certificateArn")
		_type := cfg.Require("type")
		myDomainName, err := apigateway.NewDomainName(ctx, "myDomainName", &apigateway.DomainNameArgs{
			CertificateArn: pulumi.String(certificateArn),
			DomainName:     pulumi.String(cfnDomainName),
			EndpointConfiguration: &apigateway.DomainNameEndpointConfigurationArgs{
				Types: pulumi.StringArray{
					pulumi.String(_type),
				},
			},
			RegionalCertificateArn: pulumi.String(certificateArn),
		})
		if err != nil {
			return err
		}
		ctx.Export("domainName", myDomainName.ID())
		return nil
	})
}

```

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.

func (*DomainName) ElementType 

func (*DomainName) ElementType() reflect.Type

func (*DomainName) ToDomainNameOutput 

func (i *DomainName) ToDomainNameOutput() DomainNameOutput

func (*DomainName) ToDomainNameOutputWithContext 

func (i *DomainName) ToDomainNameOutputWithContext(ctx context.Context) DomainNameOutput

type DomainNameArgs 

type DomainNameArgs struct {
	CertificateArn                      pulumi.StringPtrInput
	DomainName                          pulumi.StringPtrInput
	EndpointConfiguration               DomainNameEndpointConfigurationPtrInput
	MutualTlsAuthentication             DomainNameMutualTlsAuthenticationPtrInput
	OwnershipVerificationCertificateArn pulumi.StringPtrInput
	RegionalCertificateArn              pulumi.StringPtrInput
	SecurityPolicy                      pulumi.StringPtrInput
	Tags                                aws.TagArrayInput
}

The set of arguments for constructing a DomainName resource.

func (DomainNameArgs) ElementType 

func (DomainNameArgs) ElementType() reflect.Type

type DomainNameEndpointConfiguration 

type DomainNameEndpointConfiguration struct {
	Types []string `pulumi:"types"`
}

type DomainNameEndpointConfigurationArgs 

type DomainNameEndpointConfigurationArgs struct {
	Types pulumi.StringArrayInput `pulumi:"types"`
}

func (DomainNameEndpointConfigurationArgs) ElementType 

func (DomainNameEndpointConfigurationArgs) ElementType() reflect.Type

func (DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationOutput 

func (i DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationOutput() DomainNameEndpointConfigurationOutput

func (DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationOutputWithContext 

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

func (DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationPtrOutput 

func (i DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationPtrOutput() DomainNameEndpointConfigurationPtrOutput

func (DomainNameEndpointConfigurationArgs) ToDomainNameEndpointConfigurationPtrOutputWithContext 

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

type DomainNameEndpointConfigurationInput 

type DomainNameEndpointConfigurationInput interface {
	pulumi.Input

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

DomainNameEndpointConfigurationInput is an input type that accepts DomainNameEndpointConfigurationArgs and DomainNameEndpointConfigurationOutput values. You can construct a concrete instance of `DomainNameEndpointConfigurationInput` via: 

DomainNameEndpointConfigurationArgs{...}

type DomainNameEndpointConfigurationOutput 

type DomainNameEndpointConfigurationOutput struct{ *pulumi.OutputState }

func (DomainNameEndpointConfigurationOutput) ElementType 

func (DomainNameEndpointConfigurationOutput) ElementType() reflect.Type

func (DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationOutput 

func (o DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationOutput() DomainNameEndpointConfigurationOutput

func (DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationOutputWithContext 

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

func (DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationPtrOutput 

func (o DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationPtrOutput() DomainNameEndpointConfigurationPtrOutput

func (DomainNameEndpointConfigurationOutput) ToDomainNameEndpointConfigurationPtrOutputWithContext 

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

func (DomainNameEndpointConfigurationOutput) Types 

func (o DomainNameEndpointConfigurationOutput) Types() pulumi.StringArrayOutput

type DomainNameEndpointConfigurationPtrInput 

type DomainNameEndpointConfigurationPtrInput interface {
	pulumi.Input

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

DomainNameEndpointConfigurationPtrInput is an input type that accepts DomainNameEndpointConfigurationArgs, DomainNameEndpointConfigurationPtr and DomainNameEndpointConfigurationPtrOutput values. You can construct a concrete instance of `DomainNameEndpointConfigurationPtrInput` via: 

        DomainNameEndpointConfigurationArgs{...}

or:

        nil

func DomainNameEndpointConfigurationPtr 

func DomainNameEndpointConfigurationPtr(v *DomainNameEndpointConfigurationArgs) DomainNameEndpointConfigurationPtrInput

type DomainNameEndpointConfigurationPtrOutput 

type DomainNameEndpointConfigurationPtrOutput struct{ *pulumi.OutputState }

func (DomainNameEndpointConfigurationPtrOutput) Elem 

func (o DomainNameEndpointConfigurationPtrOutput) Elem() DomainNameEndpointConfigurationOutput

func (DomainNameEndpointConfigurationPtrOutput) ElementType 

func (DomainNameEndpointConfigurationPtrOutput) ElementType() reflect.Type

func (DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutput 

func (o DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutput() DomainNameEndpointConfigurationPtrOutput

func (DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutputWithContext 

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

func (DomainNameEndpointConfigurationPtrOutput) Types 

func (o DomainNameEndpointConfigurationPtrOutput) Types() pulumi.StringArrayOutput

type DomainNameInput 

type DomainNameInput interface {
	pulumi.Input

	ToDomainNameOutput() DomainNameOutput
	ToDomainNameOutputWithContext(ctx context.Context) DomainNameOutput
}

type DomainNameMutualTlsAuthentication 

type DomainNameMutualTlsAuthentication struct {
	TruststoreUri     *string `pulumi:"truststoreUri"`
	TruststoreVersion *string `pulumi:"truststoreVersion"`
}

type DomainNameMutualTlsAuthenticationArgs 

type DomainNameMutualTlsAuthenticationArgs struct {
	TruststoreUri     pulumi.StringPtrInput `pulumi:"truststoreUri"`
	TruststoreVersion pulumi.StringPtrInput `pulumi:"truststoreVersion"`
}

func (DomainNameMutualTlsAuthenticationArgs) ElementType 

func (DomainNameMutualTlsAuthenticationArgs) ElementType() reflect.Type

func (DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationOutput 

func (i DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationOutput() DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationOutputWithContext 

func (i DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationPtrOutput 

func (i DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationPtrOutput() DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext 

func (i DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationPtrOutput

type DomainNameMutualTlsAuthenticationInput 

type DomainNameMutualTlsAuthenticationInput interface {
	pulumi.Input

	ToDomainNameMutualTlsAuthenticationOutput() DomainNameMutualTlsAuthenticationOutput
	ToDomainNameMutualTlsAuthenticationOutputWithContext(context.Context) DomainNameMutualTlsAuthenticationOutput
}

DomainNameMutualTlsAuthenticationInput is an input type that accepts DomainNameMutualTlsAuthenticationArgs and DomainNameMutualTlsAuthenticationOutput values. You can construct a concrete instance of `DomainNameMutualTlsAuthenticationInput` via: 

DomainNameMutualTlsAuthenticationArgs{...}

type DomainNameMutualTlsAuthenticationOutput 

type DomainNameMutualTlsAuthenticationOutput struct{ *pulumi.OutputState }

func (DomainNameMutualTlsAuthenticationOutput) ElementType 

func (DomainNameMutualTlsAuthenticationOutput) ElementType() reflect.Type

func (DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationOutput 

func (o DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationOutput() DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationOutputWithContext 

func (o DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationPtrOutput 

func (o DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationPtrOutput() DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext 

func (o DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationOutput) TruststoreUri 

func (o DomainNameMutualTlsAuthenticationOutput) TruststoreUri() pulumi.StringPtrOutput

func (DomainNameMutualTlsAuthenticationOutput) TruststoreVersion 

func (o DomainNameMutualTlsAuthenticationOutput) TruststoreVersion() pulumi.StringPtrOutput

type DomainNameMutualTlsAuthenticationPtrInput 

type DomainNameMutualTlsAuthenticationPtrInput interface {
	pulumi.Input

	ToDomainNameMutualTlsAuthenticationPtrOutput() DomainNameMutualTlsAuthenticationPtrOutput
	ToDomainNameMutualTlsAuthenticationPtrOutputWithContext(context.Context) DomainNameMutualTlsAuthenticationPtrOutput
}

DomainNameMutualTlsAuthenticationPtrInput is an input type that accepts DomainNameMutualTlsAuthenticationArgs, DomainNameMutualTlsAuthenticationPtr and DomainNameMutualTlsAuthenticationPtrOutput values. You can construct a concrete instance of `DomainNameMutualTlsAuthenticationPtrInput` via: 

        DomainNameMutualTlsAuthenticationArgs{...}

or:

        nil

func DomainNameMutualTlsAuthenticationPtr 

func DomainNameMutualTlsAuthenticationPtr(v *DomainNameMutualTlsAuthenticationArgs) DomainNameMutualTlsAuthenticationPtrInput

type DomainNameMutualTlsAuthenticationPtrOutput 

type DomainNameMutualTlsAuthenticationPtrOutput struct{ *pulumi.OutputState }

func (DomainNameMutualTlsAuthenticationPtrOutput) Elem 

func (o DomainNameMutualTlsAuthenticationPtrOutput) Elem() DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationPtrOutput) ElementType 

func (DomainNameMutualTlsAuthenticationPtrOutput) ElementType() reflect.Type

func (DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutput 

func (o DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutput() DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext 

func (o DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationPtrOutput) TruststoreUri 

func (o DomainNameMutualTlsAuthenticationPtrOutput) TruststoreUri() pulumi.StringPtrOutput

func (DomainNameMutualTlsAuthenticationPtrOutput) TruststoreVersion 

func (o DomainNameMutualTlsAuthenticationPtrOutput) TruststoreVersion() pulumi.StringPtrOutput

type DomainNameOutput 

type DomainNameOutput struct{ *pulumi.OutputState }

func (DomainNameOutput) CertificateArn added in v0.17.0 

func (o DomainNameOutput) CertificateArn() pulumi.StringPtrOutput

func (DomainNameOutput) DistributionDomainName added in v0.17.0 

func (o DomainNameOutput) DistributionDomainName() pulumi.StringOutput

func (DomainNameOutput) DistributionHostedZoneId added in v0.17.0 

func (o DomainNameOutput) DistributionHostedZoneId() pulumi.StringOutput

func (DomainNameOutput) DomainName added in v0.17.0 

func (o DomainNameOutput) DomainName() pulumi.StringPtrOutput

func (DomainNameOutput) ElementType 

func (DomainNameOutput) ElementType() reflect.Type

func (DomainNameOutput) EndpointConfiguration added in v0.17.0 

func (o DomainNameOutput) EndpointConfiguration() DomainNameEndpointConfigurationPtrOutput

func (DomainNameOutput) MutualTlsAuthentication added in v0.17.0 

func (o DomainNameOutput) MutualTlsAuthentication() DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameOutput) OwnershipVerificationCertificateArn added in v0.17.0 

func (o DomainNameOutput) OwnershipVerificationCertificateArn() pulumi.StringPtrOutput

func (DomainNameOutput) RegionalCertificateArn added in v0.17.0 

func (o DomainNameOutput) RegionalCertificateArn() pulumi.StringPtrOutput

func (DomainNameOutput) RegionalDomainName added in v0.17.0 

func (o DomainNameOutput) RegionalDomainName() pulumi.StringOutput

func (DomainNameOutput) RegionalHostedZoneId added in v0.17.0 

func (o DomainNameOutput) RegionalHostedZoneId() pulumi.StringOutput

func (DomainNameOutput) SecurityPolicy added in v0.17.0 

func (o DomainNameOutput) SecurityPolicy() pulumi.StringPtrOutput

func (DomainNameOutput) Tags added in v0.17.0 

func (o DomainNameOutput) Tags() aws.TagArrayOutput

func (DomainNameOutput) ToDomainNameOutput 

func (o DomainNameOutput) ToDomainNameOutput() DomainNameOutput

func (DomainNameOutput) ToDomainNameOutputWithContext 

func (o DomainNameOutput) ToDomainNameOutputWithContext(ctx context.Context) DomainNameOutput

type DomainNameState 

type DomainNameState struct {
}

func (DomainNameState) ElementType 

func (DomainNameState) ElementType() reflect.Type

type DomainNameTag 

type DomainNameTag struct {
	Key   *string `pulumi:"key"`
	Value *string `pulumi:"value"`
}

type LookupAccountArgs added in v0.12.0 

type LookupAccountArgs struct {
	Id string `pulumi:"id"`
}

type LookupAccountOutputArgs added in v0.12.0 

type LookupAccountOutputArgs struct {
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupAccountOutputArgs) ElementType added in v0.12.0 

func (LookupAccountOutputArgs) ElementType() reflect.Type

type LookupAccountResult added in v0.12.0 

type LookupAccountResult struct {
	// The ARN of an Amazon CloudWatch role for the current Account.
	CloudWatchRoleArn *string `pulumi:"cloudWatchRoleArn"`
	Id                *string `pulumi:"id"`
}

func LookupAccount added in v0.12.0 

func LookupAccount(ctx *pulumi.Context, args *LookupAccountArgs, opts ...pulumi.InvokeOption) (*LookupAccountResult, error)

The “AWS::ApiGateway::Account“ resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one “AWS::ApiGateway::Account“ resource per region per account.

type LookupAccountResultOutput added in v0.12.0 

type LookupAccountResultOutput struct{ *pulumi.OutputState }

func LookupAccountOutput added in v0.12.0 

func LookupAccountOutput(ctx *pulumi.Context, args LookupAccountOutputArgs, opts ...pulumi.InvokeOption) LookupAccountResultOutput

func (LookupAccountResultOutput) CloudWatchRoleArn added in v0.12.0 

func (o LookupAccountResultOutput) CloudWatchRoleArn() pulumi.StringPtrOutput

The ARN of an Amazon CloudWatch role for the current Account.

func (LookupAccountResultOutput) ElementType added in v0.12.0 

func (LookupAccountResultOutput) ElementType() reflect.Type

func (LookupAccountResultOutput) Id added in v0.12.0 

func (o LookupAccountResultOutput) Id() pulumi.StringPtrOutput

func (LookupAccountResultOutput) ToLookupAccountResultOutput added in v0.12.0 

func (o LookupAccountResultOutput) ToLookupAccountResultOutput() LookupAccountResultOutput

func (LookupAccountResultOutput) ToLookupAccountResultOutputWithContext added in v0.12.0 

func (o LookupAccountResultOutput) ToLookupAccountResultOutputWithContext(ctx context.Context) LookupAccountResultOutput

type LookupApiKeyArgs added in v0.12.0 

type LookupApiKeyArgs struct {
	ApiKeyId string `pulumi:"apiKeyId"`
}

type LookupApiKeyOutputArgs added in v0.12.0 

type LookupApiKeyOutputArgs struct {
	ApiKeyId pulumi.StringInput `pulumi:"apiKeyId"`
}

func (LookupApiKeyOutputArgs) ElementType added in v0.12.0 

func (LookupApiKeyOutputArgs) ElementType() reflect.Type

type LookupApiKeyResult added in v0.12.0 

type LookupApiKeyResult struct {
	ApiKeyId *string `pulumi:"apiKeyId"`
	// An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
	CustomerId *string `pulumi:"customerId"`
	// The description of the ApiKey.
	Description *string `pulumi:"description"`
	// Specifies whether the ApiKey can be used by callers.
	Enabled *bool `pulumi:"enabled"`
	// DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
	StageKeys []ApiKeyStageKey `pulumi:"stageKeys"`
	// The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupApiKey added in v0.12.0 

func LookupApiKey(ctx *pulumi.Context, args *LookupApiKeyArgs, opts ...pulumi.InvokeOption) (*LookupApiKeyResult, error)

The “AWS::ApiGateway::ApiKey“ resource creates a unique key that you can distribute to clients who are executing API Gateway “Method“ resources that require an API key. To specify which API key clients must use, map the API key with the “RestApi“ and “Stage“ resources that include the methods that require a key.

type LookupApiKeyResultOutput added in v0.12.0 

type LookupApiKeyResultOutput struct{ *pulumi.OutputState }

func LookupApiKeyOutput added in v0.12.0 

func LookupApiKeyOutput(ctx *pulumi.Context, args LookupApiKeyOutputArgs, opts ...pulumi.InvokeOption) LookupApiKeyResultOutput

func (LookupApiKeyResultOutput) ApiKeyId added in v0.72.0 

func (o LookupApiKeyResultOutput) ApiKeyId() pulumi.StringPtrOutput

func (LookupApiKeyResultOutput) CustomerId added in v0.12.0 

func (o LookupApiKeyResultOutput) CustomerId() pulumi.StringPtrOutput

An MKT customer identifier, when integrating with the AWS SaaS Marketplace.

func (LookupApiKeyResultOutput) Description added in v0.12.0 

func (o LookupApiKeyResultOutput) Description() pulumi.StringPtrOutput

The description of the ApiKey.

func (LookupApiKeyResultOutput) ElementType added in v0.12.0 

func (LookupApiKeyResultOutput) ElementType() reflect.Type

func (LookupApiKeyResultOutput) Enabled added in v0.12.0 

func (o LookupApiKeyResultOutput) Enabled() pulumi.BoolPtrOutput

Specifies whether the ApiKey can be used by callers.

func (LookupApiKeyResultOutput) StageKeys added in v0.12.0 

func (o LookupApiKeyResultOutput) StageKeys() ApiKeyStageKeyArrayOutput

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

func (LookupApiKeyResultOutput) Tags added in v0.12.0 

func (o LookupApiKeyResultOutput) Tags() aws.TagArrayOutput

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.

func (LookupApiKeyResultOutput) ToLookupApiKeyResultOutput added in v0.12.0 

func (o LookupApiKeyResultOutput) ToLookupApiKeyResultOutput() LookupApiKeyResultOutput

func (LookupApiKeyResultOutput) ToLookupApiKeyResultOutputWithContext added in v0.12.0 

func (o LookupApiKeyResultOutput) ToLookupApiKeyResultOutputWithContext(ctx context.Context) LookupApiKeyResultOutput

type LookupAuthorizerArgs added in v0.12.0 

type LookupAuthorizerArgs struct {
	AuthorizerId string `pulumi:"authorizerId"`
	// The string identifier of the associated RestApi.
	RestApiId string `pulumi:"restApiId"`
}

type LookupAuthorizerOutputArgs added in v0.12.0 

type LookupAuthorizerOutputArgs struct {
	AuthorizerId pulumi.StringInput `pulumi:"authorizerId"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupAuthorizerOutputArgs) ElementType added in v0.12.0 

func (LookupAuthorizerOutputArgs) ElementType() reflect.Type

type LookupAuthorizerResult added in v0.12.0 

type LookupAuthorizerResult struct {
	// Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
	AuthType *string `pulumi:"authType"`
	// Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
	AuthorizerCredentials *string `pulumi:"authorizerCredentials"`
	AuthorizerId          *string `pulumi:"authorizerId"`
	// The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
	AuthorizerResultTtlInSeconds *int `pulumi:"authorizerResultTtlInSeconds"`
	// Specifies the authorizer's Uniform Resource Identifier (URI). For “TOKEN“ or “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where “{region}“ is the same as the region hosting the Lambda function, “path“ indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.
	AuthorizerUri *string `pulumi:"authorizerUri"`
	// The identity source for which authorization is requested. For a “TOKEN“ or “COGNITO_USER_POOLS“ authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is “Auth“, the header mapping expression is “method.request.header.Auth“. For the “REQUEST“ authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an “Auth“ header, a “Name“ query string parameter are defined as identity sources, this value is “method.request.header.Auth, method.request.querystring.Name“. These parameters will be used to derive the authorization caching key and to perform runtime validation of the “REQUEST“ authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
	IdentitySource *string `pulumi:"identitySource"`
	// A validation expression for the incoming identity token. For “TOKEN“ authorizers, this value is a regular expression. For “COGNITO_USER_POOLS“ authorizers, API Gateway will match the “aud“ field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the “REQUEST“ authorizer.
	IdentityValidationExpression *string `pulumi:"identityValidationExpression"`
	// The name of the authorizer.
	Name *string `pulumi:"name"`
	// A list of the Amazon Cognito user pool ARNs for the “COGNITO_USER_POOLS“ authorizer. Each element is of this format: “arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}“. For a “TOKEN“ or “REQUEST“ authorizer, this is not defined.
	ProviderArns []string `pulumi:"providerArns"`
	// The authorizer type. Valid 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, and “COGNITO_USER_POOLS“ for using an Amazon Cognito user pool.
	Type *string `pulumi:"type"`
}

func LookupAuthorizer added in v0.12.0 

func LookupAuthorizer(ctx *pulumi.Context, args *LookupAuthorizerArgs, opts ...pulumi.InvokeOption) (*LookupAuthorizerResult, error)

The “AWS::ApiGateway::Authorizer“ resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.

type LookupAuthorizerResultOutput added in v0.12.0 

type LookupAuthorizerResultOutput struct{ *pulumi.OutputState }

func LookupAuthorizerOutput added in v0.12.0 

func LookupAuthorizerOutput(ctx *pulumi.Context, args LookupAuthorizerOutputArgs, opts ...pulumi.InvokeOption) LookupAuthorizerResultOutput

func (LookupAuthorizerResultOutput) AuthType added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthType() pulumi.StringPtrOutput

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

func (LookupAuthorizerResultOutput) AuthorizerCredentials added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthorizerCredentials() pulumi.StringPtrOutput

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

func (LookupAuthorizerResultOutput) AuthorizerId added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthorizerId() pulumi.StringPtrOutput

func (LookupAuthorizerResultOutput) AuthorizerResultTtlInSeconds added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthorizerResultTtlInSeconds() pulumi.IntPtrOutput

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

func (LookupAuthorizerResultOutput) AuthorizerUri added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthorizerUri() pulumi.StringPtrOutput

Specifies the authorizer's Uniform Resource Identifier (URI). For “TOKEN“ or “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where “{region}“ is the same as the region hosting the Lambda function, “path“ indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.

func (LookupAuthorizerResultOutput) ElementType added in v0.12.0 

func (LookupAuthorizerResultOutput) ElementType() reflect.Type

func (LookupAuthorizerResultOutput) IdentitySource added in v0.12.0 

func (o LookupAuthorizerResultOutput) IdentitySource() pulumi.StringPtrOutput

The identity source for which authorization is requested. For a “TOKEN“ or “COGNITO_USER_POOLS“ authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is “Auth“, the header mapping expression is “method.request.header.Auth“. For the “REQUEST“ authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an “Auth“ header, a “Name“ query string parameter are defined as identity sources, this value is “method.request.header.Auth, method.request.querystring.Name“. These parameters will be used to derive the authorization caching key and to perform runtime validation of the “REQUEST“ authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

func (LookupAuthorizerResultOutput) IdentityValidationExpression added in v0.12.0 

func (o LookupAuthorizerResultOutput) IdentityValidationExpression() pulumi.StringPtrOutput

A validation expression for the incoming identity token. For “TOKEN“ authorizers, this value is a regular expression. For “COGNITO_USER_POOLS“ authorizers, API Gateway will match the “aud“ field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the “REQUEST“ authorizer.

func (LookupAuthorizerResultOutput) Name added in v0.12.0 

func (o LookupAuthorizerResultOutput) Name() pulumi.StringPtrOutput

The name of the authorizer.

func (LookupAuthorizerResultOutput) ProviderArns added in v0.72.0 

func (o LookupAuthorizerResultOutput) ProviderArns() pulumi.StringArrayOutput

A list of the Amazon Cognito user pool ARNs for the “COGNITO_USER_POOLS“ authorizer. Each element is of this format: “arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}“. For a “TOKEN“ or “REQUEST“ authorizer, this is not defined.

func (LookupAuthorizerResultOutput) ToLookupAuthorizerResultOutput added in v0.12.0 

func (o LookupAuthorizerResultOutput) ToLookupAuthorizerResultOutput() LookupAuthorizerResultOutput

func (LookupAuthorizerResultOutput) ToLookupAuthorizerResultOutputWithContext added in v0.12.0 

func (o LookupAuthorizerResultOutput) ToLookupAuthorizerResultOutputWithContext(ctx context.Context) LookupAuthorizerResultOutput

func (LookupAuthorizerResultOutput) Type added in v0.12.0 

func (o LookupAuthorizerResultOutput) Type() pulumi.StringPtrOutput

The authorizer type. Valid 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, and “COGNITO_USER_POOLS“ for using an Amazon Cognito user pool.

type LookupBasePathMappingArgs added in v0.12.0 

type LookupBasePathMappingArgs struct {
	// The base path name that callers of the API must provide as part of the URL after the domain name.
	BasePath string `pulumi:"basePath"`
	// The domain name of the BasePathMapping resource to be described.
	DomainName string `pulumi:"domainName"`
}

type LookupBasePathMappingOutputArgs added in v0.12.0 

type LookupBasePathMappingOutputArgs struct {
	// The base path name that callers of the API must provide as part of the URL after the domain name.
	BasePath pulumi.StringInput `pulumi:"basePath"`
	// The domain name of the BasePathMapping resource to be described.
	DomainName pulumi.StringInput `pulumi:"domainName"`
}

func (LookupBasePathMappingOutputArgs) ElementType added in v0.12.0 

func (LookupBasePathMappingOutputArgs) ElementType() reflect.Type

type LookupBasePathMappingResult added in v0.12.0 

type LookupBasePathMappingResult struct {
	// The string identifier of the associated RestApi.
	RestApiId *string `pulumi:"restApiId"`
	// The name of the associated stage.
	Stage *string `pulumi:"stage"`
}

func LookupBasePathMapping added in v0.12.0 

func LookupBasePathMapping(ctx *pulumi.Context, args *LookupBasePathMappingArgs, opts ...pulumi.InvokeOption) (*LookupBasePathMappingResult, error)

The “AWS::ApiGateway::BasePathMapping“ resource creates a base path that clients who call your API must use in the invocation URL.

type LookupBasePathMappingResultOutput added in v0.12.0 

type LookupBasePathMappingResultOutput struct{ *pulumi.OutputState }

func LookupBasePathMappingOutput added in v0.12.0 

func LookupBasePathMappingOutput(ctx *pulumi.Context, args LookupBasePathMappingOutputArgs, opts ...pulumi.InvokeOption) LookupBasePathMappingResultOutput

func (LookupBasePathMappingResultOutput) ElementType added in v0.12.0 

func (LookupBasePathMappingResultOutput) ElementType() reflect.Type

func (LookupBasePathMappingResultOutput) RestApiId added in v0.12.0 

func (o LookupBasePathMappingResultOutput) RestApiId() pulumi.StringPtrOutput

The string identifier of the associated RestApi.

func (LookupBasePathMappingResultOutput) Stage added in v0.12.0 

func (o LookupBasePathMappingResultOutput) Stage() pulumi.StringPtrOutput

The name of the associated stage.

func (LookupBasePathMappingResultOutput) ToLookupBasePathMappingResultOutput added in v0.12.0 

func (o LookupBasePathMappingResultOutput) ToLookupBasePathMappingResultOutput() LookupBasePathMappingResultOutput

func (LookupBasePathMappingResultOutput) ToLookupBasePathMappingResultOutputWithContext added in v0.12.0 

func (o LookupBasePathMappingResultOutput) ToLookupBasePathMappingResultOutputWithContext(ctx context.Context) LookupBasePathMappingResultOutput

type LookupClientCertificateArgs added in v0.12.0 

type LookupClientCertificateArgs struct {
	ClientCertificateId string `pulumi:"clientCertificateId"`
}

type LookupClientCertificateOutputArgs added in v0.12.0 

type LookupClientCertificateOutputArgs struct {
	ClientCertificateId pulumi.StringInput `pulumi:"clientCertificateId"`
}

func (LookupClientCertificateOutputArgs) ElementType added in v0.12.0 

func (LookupClientCertificateOutputArgs) ElementType() reflect.Type

type LookupClientCertificateResult added in v0.12.0 

type LookupClientCertificateResult struct {
	ClientCertificateId *string `pulumi:"clientCertificateId"`
	// The description of the client certificate.
	Description *string `pulumi:"description"`
	// The collection of tags. Each tag element is associated with a given resource.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupClientCertificate added in v0.12.0 

func LookupClientCertificate(ctx *pulumi.Context, args *LookupClientCertificateArgs, opts ...pulumi.InvokeOption) (*LookupClientCertificateResult, error)

The “AWS::ApiGateway::ClientCertificate“ resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.

type LookupClientCertificateResultOutput added in v0.12.0 

type LookupClientCertificateResultOutput struct{ *pulumi.OutputState }

func LookupClientCertificateOutput added in v0.12.0 

func LookupClientCertificateOutput(ctx *pulumi.Context, args LookupClientCertificateOutputArgs, opts ...pulumi.InvokeOption) LookupClientCertificateResultOutput

func (LookupClientCertificateResultOutput) ClientCertificateId added in v0.12.0 

func (o LookupClientCertificateResultOutput) ClientCertificateId() pulumi.StringPtrOutput

func (LookupClientCertificateResultOutput) Description added in v0.12.0 

func (o LookupClientCertificateResultOutput) Description() pulumi.StringPtrOutput

The description of the client certificate.

func (LookupClientCertificateResultOutput) ElementType added in v0.12.0 

func (LookupClientCertificateResultOutput) ElementType() reflect.Type

func (LookupClientCertificateResultOutput) Tags added in v0.12.0 

func (o LookupClientCertificateResultOutput) Tags() aws.TagArrayOutput

The collection of tags. Each tag element is associated with a given resource.

func (LookupClientCertificateResultOutput) ToLookupClientCertificateResultOutput added in v0.12.0 

func (o LookupClientCertificateResultOutput) ToLookupClientCertificateResultOutput() LookupClientCertificateResultOutput

func (LookupClientCertificateResultOutput) ToLookupClientCertificateResultOutputWithContext added in v0.12.0 

func (o LookupClientCertificateResultOutput) ToLookupClientCertificateResultOutputWithContext(ctx context.Context) LookupClientCertificateResultOutput

type LookupDeploymentArgs added in v0.12.0 

type LookupDeploymentArgs struct {
	DeploymentId string `pulumi:"deploymentId"`
	// The string identifier of the associated RestApi.
	RestApiId string `pulumi:"restApiId"`
}

type LookupDeploymentOutputArgs added in v0.12.0 

type LookupDeploymentOutputArgs struct {
	DeploymentId pulumi.StringInput `pulumi:"deploymentId"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupDeploymentOutputArgs) ElementType added in v0.12.0 

func (LookupDeploymentOutputArgs) ElementType() reflect.Type

type LookupDeploymentResult added in v0.12.0 

type LookupDeploymentResult struct {
	DeploymentId *string `pulumi:"deploymentId"`
	// The description for the Deployment resource to create.
	Description *string `pulumi:"description"`
}

func LookupDeployment added in v0.12.0 

func LookupDeployment(ctx *pulumi.Context, args *LookupDeploymentArgs, opts ...pulumi.InvokeOption) (*LookupDeploymentResult, error)

The “AWS::ApiGateway::Deployment“ resource deploys an API Gateway “RestApi“ resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

type LookupDeploymentResultOutput added in v0.12.0 

type LookupDeploymentResultOutput struct{ *pulumi.OutputState }

func LookupDeploymentOutput added in v0.12.0 

func LookupDeploymentOutput(ctx *pulumi.Context, args LookupDeploymentOutputArgs, opts ...pulumi.InvokeOption) LookupDeploymentResultOutput

func (LookupDeploymentResultOutput) DeploymentId added in v0.12.0 

func (o LookupDeploymentResultOutput) DeploymentId() pulumi.StringPtrOutput

func (LookupDeploymentResultOutput) Description added in v0.12.0 

func (o LookupDeploymentResultOutput) Description() pulumi.StringPtrOutput

The description for the Deployment resource to create.

func (LookupDeploymentResultOutput) ElementType added in v0.12.0 

func (LookupDeploymentResultOutput) ElementType() reflect.Type

func (LookupDeploymentResultOutput) ToLookupDeploymentResultOutput added in v0.12.0 

func (o LookupDeploymentResultOutput) ToLookupDeploymentResultOutput() LookupDeploymentResultOutput

func (LookupDeploymentResultOutput) ToLookupDeploymentResultOutputWithContext added in v0.12.0 

func (o LookupDeploymentResultOutput) ToLookupDeploymentResultOutputWithContext(ctx context.Context) LookupDeploymentResultOutput

type LookupDocumentationPartArgs added in v0.12.0 

type LookupDocumentationPartArgs struct {
	DocumentationPartId string `pulumi:"documentationPartId"`
	// The string identifier of the associated RestApi.
	RestApiId string `pulumi:"restApiId"`
}

type LookupDocumentationPartOutputArgs added in v0.12.0 

type LookupDocumentationPartOutputArgs struct {
	DocumentationPartId pulumi.StringInput `pulumi:"documentationPartId"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupDocumentationPartOutputArgs) ElementType added in v0.12.0 

func (LookupDocumentationPartOutputArgs) ElementType() reflect.Type

type LookupDocumentationPartResult added in v0.12.0 

type LookupDocumentationPartResult struct {
	DocumentationPartId *string `pulumi:"documentationPartId"`
	// The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
	Properties *string `pulumi:"properties"`
}

func LookupDocumentationPart added in v0.12.0 

func LookupDocumentationPart(ctx *pulumi.Context, args *LookupDocumentationPartArgs, opts ...pulumi.InvokeOption) (*LookupDocumentationPartResult, error)

The “AWS::ApiGateway::DocumentationPart“ resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.

type LookupDocumentationPartResultOutput added in v0.12.0 

type LookupDocumentationPartResultOutput struct{ *pulumi.OutputState }

func LookupDocumentationPartOutput added in v0.12.0 

func LookupDocumentationPartOutput(ctx *pulumi.Context, args LookupDocumentationPartOutputArgs, opts ...pulumi.InvokeOption) LookupDocumentationPartResultOutput

func (LookupDocumentationPartResultOutput) DocumentationPartId added in v0.21.0 

func (o LookupDocumentationPartResultOutput) DocumentationPartId() pulumi.StringPtrOutput

func (LookupDocumentationPartResultOutput) ElementType added in v0.12.0 

func (LookupDocumentationPartResultOutput) ElementType() reflect.Type

func (LookupDocumentationPartResultOutput) Properties added in v0.12.0 

func (o LookupDocumentationPartResultOutput) Properties() pulumi.StringPtrOutput

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

func (LookupDocumentationPartResultOutput) ToLookupDocumentationPartResultOutput added in v0.12.0 

func (o LookupDocumentationPartResultOutput) ToLookupDocumentationPartResultOutput() LookupDocumentationPartResultOutput

func (LookupDocumentationPartResultOutput) ToLookupDocumentationPartResultOutputWithContext added in v0.12.0 

func (o LookupDocumentationPartResultOutput) ToLookupDocumentationPartResultOutputWithContext(ctx context.Context) LookupDocumentationPartResultOutput

type LookupDocumentationVersionArgs added in v0.12.0 

type LookupDocumentationVersionArgs struct {
	// The version identifier of the to-be-updated documentation version.
	DocumentationVersion string `pulumi:"documentationVersion"`
	// The string identifier of the associated RestApi.
	RestApiId string `pulumi:"restApiId"`
}

type LookupDocumentationVersionOutputArgs added in v0.12.0 

type LookupDocumentationVersionOutputArgs struct {
	// The version identifier of the to-be-updated documentation version.
	DocumentationVersion pulumi.StringInput `pulumi:"documentationVersion"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupDocumentationVersionOutputArgs) ElementType added in v0.12.0 

func (LookupDocumentationVersionOutputArgs) ElementType() reflect.Type

type LookupDocumentationVersionResult added in v0.12.0 

type LookupDocumentationVersionResult struct {
	// A description about the new documentation snapshot.
	Description *string `pulumi:"description"`
}

func LookupDocumentationVersion added in v0.12.0 

func LookupDocumentationVersion(ctx *pulumi.Context, args *LookupDocumentationVersionArgs, opts ...pulumi.InvokeOption) (*LookupDocumentationVersionResult, error)

The “AWS::ApiGateway::DocumentationVersion“ resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.

type LookupDocumentationVersionResultOutput added in v0.12.0 

type LookupDocumentationVersionResultOutput struct{ *pulumi.OutputState }

func LookupDocumentationVersionOutput added in v0.12.0 

func LookupDocumentationVersionOutput(ctx *pulumi.Context, args LookupDocumentationVersionOutputArgs, opts ...pulumi.InvokeOption) LookupDocumentationVersionResultOutput

func (LookupDocumentationVersionResultOutput) Description added in v0.12.0 

func (o LookupDocumentationVersionResultOutput) Description() pulumi.StringPtrOutput

A description about the new documentation snapshot.

func (LookupDocumentationVersionResultOutput) ElementType added in v0.12.0 

func (LookupDocumentationVersionResultOutput) ElementType() reflect.Type

func (LookupDocumentationVersionResultOutput) ToLookupDocumentationVersionResultOutput added in v0.12.0 

func (o LookupDocumentationVersionResultOutput) ToLookupDocumentationVersionResultOutput() LookupDocumentationVersionResultOutput

func (LookupDocumentationVersionResultOutput) ToLookupDocumentationVersionResultOutputWithContext added in v0.12.0 

func (o LookupDocumentationVersionResultOutput) ToLookupDocumentationVersionResultOutputWithContext(ctx context.Context) LookupDocumentationVersionResultOutput

type LookupDomainNameArgs added in v0.12.0 

type LookupDomainNameArgs struct {
	DomainName string `pulumi:"domainName"`
}

type LookupDomainNameOutputArgs added in v0.12.0 

type LookupDomainNameOutputArgs struct {
	DomainName pulumi.StringInput `pulumi:"domainName"`
}

func (LookupDomainNameOutputArgs) ElementType added in v0.12.0 

func (LookupDomainNameOutputArgs) ElementType() reflect.Type

type LookupDomainNameResult added in v0.12.0 

type LookupDomainNameResult struct {
	CertificateArn                      *string                            `pulumi:"certificateArn"`
	DistributionDomainName              *string                            `pulumi:"distributionDomainName"`
	DistributionHostedZoneId            *string                            `pulumi:"distributionHostedZoneId"`
	EndpointConfiguration               *DomainNameEndpointConfiguration   `pulumi:"endpointConfiguration"`
	MutualTlsAuthentication             *DomainNameMutualTlsAuthentication `pulumi:"mutualTlsAuthentication"`
	OwnershipVerificationCertificateArn *string                            `pulumi:"ownershipVerificationCertificateArn"`
	RegionalCertificateArn              *string                            `pulumi:"regionalCertificateArn"`
	RegionalDomainName                  *string                            `pulumi:"regionalDomainName"`
	RegionalHostedZoneId                *string                            `pulumi:"regionalHostedZoneId"`
	SecurityPolicy                      *string                            `pulumi:"securityPolicy"`
	Tags                                []aws.Tag                          `pulumi:"tags"`
}

func LookupDomainName added in v0.12.0 

func LookupDomainName(ctx *pulumi.Context, args *LookupDomainNameArgs, opts ...pulumi.InvokeOption) (*LookupDomainNameResult, error)

Resource Type definition for AWS::ApiGateway::DomainName.

type LookupDomainNameResultOutput added in v0.12.0 

type LookupDomainNameResultOutput struct{ *pulumi.OutputState }

func LookupDomainNameOutput added in v0.12.0 

func LookupDomainNameOutput(ctx *pulumi.Context, args LookupDomainNameOutputArgs, opts ...pulumi.InvokeOption) LookupDomainNameResultOutput

func (LookupDomainNameResultOutput) CertificateArn added in v0.12.0 

func (o LookupDomainNameResultOutput) CertificateArn() pulumi.StringPtrOutput

func (LookupDomainNameResultOutput) DistributionDomainName added in v0.12.0 

func (o LookupDomainNameResultOutput) DistributionDomainName() pulumi.StringPtrOutput

func (LookupDomainNameResultOutput) DistributionHostedZoneId added in v0.12.0 

func (o LookupDomainNameResultOutput) DistributionHostedZoneId() pulumi.StringPtrOutput

func (LookupDomainNameResultOutput) ElementType added in v0.12.0 

func (LookupDomainNameResultOutput) ElementType() reflect.Type

func (LookupDomainNameResultOutput) EndpointConfiguration added in v0.12.0 

func (o LookupDomainNameResultOutput) EndpointConfiguration() DomainNameEndpointConfigurationPtrOutput

func (LookupDomainNameResultOutput) MutualTlsAuthentication added in v0.12.0 

func (o LookupDomainNameResultOutput) MutualTlsAuthentication() DomainNameMutualTlsAuthenticationPtrOutput

func (LookupDomainNameResultOutput) OwnershipVerificationCertificateArn added in v0.12.0 

func (o LookupDomainNameResultOutput) OwnershipVerificationCertificateArn() pulumi.StringPtrOutput

func (LookupDomainNameResultOutput) RegionalCertificateArn added in v0.12.0 

func (o LookupDomainNameResultOutput) RegionalCertificateArn() pulumi.StringPtrOutput

func (LookupDomainNameResultOutput) RegionalDomainName added in v0.12.0 

func (o LookupDomainNameResultOutput) RegionalDomainName() pulumi.StringPtrOutput

func (LookupDomainNameResultOutput) RegionalHostedZoneId added in v0.12.0 

func (o LookupDomainNameResultOutput) RegionalHostedZoneId() pulumi.StringPtrOutput

func (LookupDomainNameResultOutput) SecurityPolicy added in v0.12.0 

func (o LookupDomainNameResultOutput) SecurityPolicy() pulumi.StringPtrOutput

func (LookupDomainNameResultOutput) Tags added in v0.12.0 

func (o LookupDomainNameResultOutput) Tags() aws.TagArrayOutput

func (LookupDomainNameResultOutput) ToLookupDomainNameResultOutput added in v0.12.0 

func (o LookupDomainNameResultOutput) ToLookupDomainNameResultOutput() LookupDomainNameResultOutput

func (LookupDomainNameResultOutput) ToLookupDomainNameResultOutputWithContext added in v0.12.0 

func (o LookupDomainNameResultOutput) ToLookupDomainNameResultOutputWithContext(ctx context.Context) LookupDomainNameResultOutput

type LookupMethodArgs added in v0.12.0 

type LookupMethodArgs struct {
	// The method's HTTP verb.
	HttpMethod string `pulumi:"httpMethod"`
	// The Resource identifier for the MethodResponse resource.
	ResourceId string `pulumi:"resourceId"`
	// The string identifier of the associated RestApi.
	RestApiId string `pulumi:"restApiId"`
}

type LookupMethodOutputArgs added in v0.12.0 

type LookupMethodOutputArgs struct {
	// The method's HTTP verb.
	HttpMethod pulumi.StringInput `pulumi:"httpMethod"`
	// The Resource identifier for the MethodResponse resource.
	ResourceId pulumi.StringInput `pulumi:"resourceId"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupMethodOutputArgs) ElementType added in v0.12.0 

func (LookupMethodOutputArgs) ElementType() reflect.Type

type LookupMethodResult added in v0.12.0 

type LookupMethodResult struct {
	// A boolean flag specifying whether a valid ApiKey is required to invoke this method.
	ApiKeyRequired *bool `pulumi:"apiKeyRequired"`
	// A list of authorization scopes configured on the method. The scopes are used with a “COGNITO_USER_POOLS“ authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
	AuthorizationScopes []string `pulumi:"authorizationScopes"`
	// The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.
	//   If you specify the “AuthorizerId“ property, specify “CUSTOM“ or “COGNITO_USER_POOLS“ for this property.
	AuthorizationType *MethodAuthorizationType `pulumi:"authorizationType"`
	// The identifier of an authorizer to use on this method. The method's authorization type must be “CUSTOM“ or “COGNITO_USER_POOLS“.
	AuthorizerId *string `pulumi:"authorizerId"`
	// Represents an “HTTP“, “HTTP_PROXY“, “AWS“, “AWS_PROXY“, or Mock integration.
	Integration *MethodIntegration `pulumi:"integration"`
	// Gets a method response associated with a given HTTP status code.
	MethodResponses []MethodResponse `pulumi:"methodResponses"`
	// A human-friendly operation identifier for the method. For example, you can assign the “operationName“ of “ListPets“ for the “GET /pets“ method in the “PetStore“ example.
	OperationName *string `pulumi:"operationName"`
	// A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
	RequestModels map[string]string `pulumi:"requestModels"`
	// A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of “method.request.{location}.{name}“, where “location“ is “querystring“, “path“, or “header“ and “name“ is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (“true“) or optional (“false“). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
	RequestParameters map[string]interface{} `pulumi:"requestParameters"`
	// The identifier of a RequestValidator for request validation.
	RequestValidatorId *string `pulumi:"requestValidatorId"`
}

func LookupMethod added in v0.12.0 

func LookupMethod(ctx *pulumi.Context, args *LookupMethodArgs, opts ...pulumi.InvokeOption) (*LookupMethodResult, error)

The “AWS::ApiGateway::Method“ resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

type LookupMethodResultOutput added in v0.12.0 

type LookupMethodResultOutput struct{ *pulumi.OutputState }

func LookupMethodOutput added in v0.12.0 

func LookupMethodOutput(ctx *pulumi.Context, args LookupMethodOutputArgs, opts ...pulumi.InvokeOption) LookupMethodResultOutput

func (LookupMethodResultOutput) ApiKeyRequired added in v0.12.0 

func (o LookupMethodResultOutput) ApiKeyRequired() pulumi.BoolPtrOutput

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

func (LookupMethodResultOutput) AuthorizationScopes added in v0.12.0 

func (o LookupMethodResultOutput) AuthorizationScopes() pulumi.StringArrayOutput

A list of authorization scopes configured on the method. The scopes are used with a “COGNITO_USER_POOLS“ authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

func (LookupMethodResultOutput) AuthorizationType added in v0.12.0 

func (o LookupMethodResultOutput) AuthorizationType() MethodAuthorizationTypePtrOutput

The method's authorization type. This parameter is required. For valid values, see Method(https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. 

If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.

func (LookupMethodResultOutput) AuthorizerId added in v0.12.0 

func (o LookupMethodResultOutput) AuthorizerId() pulumi.StringPtrOutput

The identifier of an authorizer to use on this method. The method's authorization type must be “CUSTOM“ or “COGNITO_USER_POOLS“.

func (LookupMethodResultOutput) ElementType added in v0.12.0 

func (LookupMethodResultOutput) ElementType() reflect.Type

func (LookupMethodResultOutput) Integration added in v0.12.0 

func (o LookupMethodResultOutput) Integration() MethodIntegrationPtrOutput

Represents an “HTTP“, “HTTP_PROXY“, “AWS“, “AWS_PROXY“, or Mock integration.

func (LookupMethodResultOutput) MethodResponses added in v0.12.0 

func (o LookupMethodResultOutput) MethodResponses() MethodResponseArrayOutput

Gets a method response associated with a given HTTP status code.

func (LookupMethodResultOutput) OperationName added in v0.12.0 

func (o LookupMethodResultOutput) OperationName() pulumi.StringPtrOutput

A human-friendly operation identifier for the method. For example, you can assign the “operationName“ of “ListPets“ for the “GET /pets“ method in the “PetStore“ example.

func (LookupMethodResultOutput) RequestModels added in v0.12.0 

func (o LookupMethodResultOutput) RequestModels() pulumi.StringMapOutput

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

func (LookupMethodResultOutput) RequestParameters added in v0.12.0 

func (o LookupMethodResultOutput) RequestParameters() pulumi.MapOutput

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of “method.request.{location}.{name}“, where “location“ is “querystring“, “path“, or “header“ and “name“ is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (“true“) or optional (“false“). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

func (LookupMethodResultOutput) RequestValidatorId added in v0.12.0 

func (o LookupMethodResultOutput) RequestValidatorId() pulumi.StringPtrOutput

The identifier of a RequestValidator for request validation.

func (LookupMethodResultOutput) ToLookupMethodResultOutput added in v0.12.0 

func (o LookupMethodResultOutput) ToLookupMethodResultOutput() LookupMethodResultOutput

func (LookupMethodResultOutput) ToLookupMethodResultOutputWithContext added in v0.12.0 

func (o LookupMethodResultOutput) ToLookupMethodResultOutputWithContext(ctx context.Context) LookupMethodResultOutput

type LookupModelArgs added in v0.12.0 

type LookupModelArgs struct {
	// A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
	//   If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	Name string `pulumi:"name"`
	// The string identifier of the associated RestApi.
	RestApiId string `pulumi:"restApiId"`
}

type LookupModelOutputArgs added in v0.12.0 

type LookupModelOutputArgs struct {
	// A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
	//   If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	Name pulumi.StringInput `pulumi:"name"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupModelOutputArgs) ElementType added in v0.12.0 

func (LookupModelOutputArgs) ElementType() reflect.Type

type LookupModelResult added in v0.12.0 

type LookupModelResult struct {
	// The description of the model.
	Description *string `pulumi:"description"`
	// The schema for the model. For “application/json“ models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::Model` for more information about the expected schema for this property.
	Schema interface{} `pulumi:"schema"`
}

func LookupModel added in v0.12.0 

func LookupModel(ctx *pulumi.Context, args *LookupModelArgs, opts ...pulumi.InvokeOption) (*LookupModelResult, error)

The “AWS::ApiGateway::Model“ resource defines the structure of a request or response payload for an API method.

type LookupModelResultOutput added in v0.12.0 

type LookupModelResultOutput struct{ *pulumi.OutputState }

func LookupModelOutput added in v0.12.0 

func LookupModelOutput(ctx *pulumi.Context, args LookupModelOutputArgs, opts ...pulumi.InvokeOption) LookupModelResultOutput

func (LookupModelResultOutput) Description added in v0.12.0 

func (o LookupModelResultOutput) Description() pulumi.StringPtrOutput

The description of the model.

func (LookupModelResultOutput) ElementType added in v0.12.0 

func (LookupModelResultOutput) ElementType() reflect.Type

func (LookupModelResultOutput) Schema added in v0.12.0 

func (o LookupModelResultOutput) Schema() pulumi.AnyOutput

The schema for the model. For “application/json“ models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::Model` for more information about the expected schema for this property.

func (LookupModelResultOutput) ToLookupModelResultOutput added in v0.12.0 

func (o LookupModelResultOutput) ToLookupModelResultOutput() LookupModelResultOutput

func (LookupModelResultOutput) ToLookupModelResultOutputWithContext added in v0.12.0 

func (o LookupModelResultOutput) ToLookupModelResultOutputWithContext(ctx context.Context) LookupModelResultOutput

type LookupRequestValidatorArgs added in v0.12.0 

type LookupRequestValidatorArgs struct {
	RequestValidatorId string `pulumi:"requestValidatorId"`
	// The string identifier of the associated RestApi.
	RestApiId string `pulumi:"restApiId"`
}

type LookupRequestValidatorOutputArgs added in v0.12.0 

type LookupRequestValidatorOutputArgs struct {
	RequestValidatorId pulumi.StringInput `pulumi:"requestValidatorId"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupRequestValidatorOutputArgs) ElementType added in v0.12.0 

func (LookupRequestValidatorOutputArgs) ElementType() reflect.Type

type LookupRequestValidatorResult added in v0.12.0 

type LookupRequestValidatorResult struct {
	RequestValidatorId *string `pulumi:"requestValidatorId"`
	// A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
	ValidateRequestBody *bool `pulumi:"validateRequestBody"`
	// A Boolean flag to indicate whether to validate request parameters (“true“) or not (“false“).
	ValidateRequestParameters *bool `pulumi:"validateRequestParameters"`
}

func LookupRequestValidator added in v0.12.0 

func LookupRequestValidator(ctx *pulumi.Context, args *LookupRequestValidatorArgs, opts ...pulumi.InvokeOption) (*LookupRequestValidatorResult, error)

The “AWS::ApiGateway::RequestValidator“ resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.

type LookupRequestValidatorResultOutput added in v0.12.0 

type LookupRequestValidatorResultOutput struct{ *pulumi.OutputState }

func LookupRequestValidatorOutput added in v0.12.0 

func LookupRequestValidatorOutput(ctx *pulumi.Context, args LookupRequestValidatorOutputArgs, opts ...pulumi.InvokeOption) LookupRequestValidatorResultOutput

func (LookupRequestValidatorResultOutput) ElementType added in v0.12.0 

func (LookupRequestValidatorResultOutput) ElementType() reflect.Type

func (LookupRequestValidatorResultOutput) RequestValidatorId added in v0.12.0 

func (o LookupRequestValidatorResultOutput) RequestValidatorId() pulumi.StringPtrOutput

func (LookupRequestValidatorResultOutput) ToLookupRequestValidatorResultOutput added in v0.12.0 

func (o LookupRequestValidatorResultOutput) ToLookupRequestValidatorResultOutput() LookupRequestValidatorResultOutput

func (LookupRequestValidatorResultOutput) ToLookupRequestValidatorResultOutputWithContext added in v0.12.0 

func (o LookupRequestValidatorResultOutput) ToLookupRequestValidatorResultOutputWithContext(ctx context.Context) LookupRequestValidatorResultOutput

func (LookupRequestValidatorResultOutput) ValidateRequestBody added in v0.12.0 

func (o LookupRequestValidatorResultOutput) ValidateRequestBody() pulumi.BoolPtrOutput

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

func (LookupRequestValidatorResultOutput) ValidateRequestParameters added in v0.12.0 

func (o LookupRequestValidatorResultOutput) ValidateRequestParameters() pulumi.BoolPtrOutput

A Boolean flag to indicate whether to validate request parameters (“true“) or not (“false“).

type LookupResourceArgs added in v0.12.0 

type LookupResourceArgs struct {
	ResourceId string `pulumi:"resourceId"`
	// The string identifier of the associated RestApi.
	RestApiId string `pulumi:"restApiId"`
}

type LookupResourceOutputArgs added in v0.12.0 

type LookupResourceOutputArgs struct {
	ResourceId pulumi.StringInput `pulumi:"resourceId"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupResourceOutputArgs) ElementType added in v0.12.0 

func (LookupResourceOutputArgs) ElementType() reflect.Type

type LookupResourceResult added in v0.12.0 

type LookupResourceResult struct {
	ResourceId *string `pulumi:"resourceId"`
}

func LookupResource added in v0.12.0 

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

The “AWS::ApiGateway::Resource“ resource creates a resource in an API.

type LookupResourceResultOutput added in v0.12.0 

type LookupResourceResultOutput struct{ *pulumi.OutputState }

func LookupResourceOutput added in v0.12.0 

func LookupResourceOutput(ctx *pulumi.Context, args LookupResourceOutputArgs, opts ...pulumi.InvokeOption) LookupResourceResultOutput

func (LookupResourceResultOutput) ElementType added in v0.12.0 

func (LookupResourceResultOutput) ElementType() reflect.Type

func (LookupResourceResultOutput) ResourceId added in v0.12.0 

func (o LookupResourceResultOutput) ResourceId() pulumi.StringPtrOutput

func (LookupResourceResultOutput) ToLookupResourceResultOutput added in v0.12.0 

func (o LookupResourceResultOutput) ToLookupResourceResultOutput() LookupResourceResultOutput

func (LookupResourceResultOutput) ToLookupResourceResultOutputWithContext added in v0.12.0 

func (o LookupResourceResultOutput) ToLookupResourceResultOutputWithContext(ctx context.Context) LookupResourceResultOutput

type LookupRestApiArgs added in v0.12.0 

type LookupRestApiArgs struct {
	RestApiId string `pulumi:"restApiId"`
}

type LookupRestApiOutputArgs added in v0.12.0 

type LookupRestApiOutputArgs struct {
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupRestApiOutputArgs) ElementType added in v0.12.0 

func (LookupRestApiOutputArgs) ElementType() reflect.Type

type LookupRestApiResult added in v0.12.0 

type LookupRestApiResult struct {
	// The source of the API key for metering requests according to a usage plan. Valid values are: “HEADER“ to read the API key from the “X-API-Key“ header of a request. “AUTHORIZER“ to read the API key from the “UsageIdentifierKey“ from a custom authorizer.
	ApiKeySourceType *string `pulumi:"apiKeySourceType"`
	// The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
	BinaryMediaTypes []string `pulumi:"binaryMediaTypes"`
	// The description of the RestApi.
	Description *string `pulumi:"description"`
	// Specifies whether clients can invoke your API by using the default “execute-api“ endpoint. By default, clients can invoke your API with the default “https://{api_id}.execute-api.{region}.amazonaws.com“ endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
	DisableExecuteApiEndpoint *bool `pulumi:"disableExecuteApiEndpoint"`
	// A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the “Parameters“ property.
	EndpointConfiguration *RestApiEndpointConfiguration `pulumi:"endpointConfiguration"`
	// A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
	MinimumCompressionSize *int `pulumi:"minimumCompressionSize"`
	// The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
	Name *string `pulumi:"name"`
	// A policy document that contains the permissions for the “RestApi“ resource. To set the ARN for the policy, use the “!Join“ intrinsic function with “""“ as delimiter and values of “"execute-api:/"“ and “"*"“.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.
	Policy         interface{} `pulumi:"policy"`
	RestApiId      *string     `pulumi:"restApiId"`
	RootResourceId *string     `pulumi:"rootResourceId"`
	// The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupRestApi added in v0.12.0 

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

The “AWS::ApiGateway::RestApi“ resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*. 

On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.

type LookupRestApiResultOutput added in v0.12.0 

type LookupRestApiResultOutput struct{ *pulumi.OutputState }

func LookupRestApiOutput added in v0.12.0 

func LookupRestApiOutput(ctx *pulumi.Context, args LookupRestApiOutputArgs, opts ...pulumi.InvokeOption) LookupRestApiResultOutput

func (LookupRestApiResultOutput) ApiKeySourceType added in v0.12.0 

func (o LookupRestApiResultOutput) ApiKeySourceType() pulumi.StringPtrOutput

The source of the API key for metering requests according to a usage plan. Valid values are: “HEADER“ to read the API key from the “X-API-Key“ header of a request. “AUTHORIZER“ to read the API key from the “UsageIdentifierKey“ from a custom authorizer.

func (LookupRestApiResultOutput) BinaryMediaTypes added in v0.12.0 

func (o LookupRestApiResultOutput) BinaryMediaTypes() pulumi.StringArrayOutput

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

func (LookupRestApiResultOutput) Description added in v0.12.0 

func (o LookupRestApiResultOutput) Description() pulumi.StringPtrOutput

The description of the RestApi.

func (LookupRestApiResultOutput) DisableExecuteApiEndpoint added in v0.12.0 

func (o LookupRestApiResultOutput) DisableExecuteApiEndpoint() pulumi.BoolPtrOutput

Specifies whether clients can invoke your API by using the default “execute-api“ endpoint. By default, clients can invoke your API with the default “https://{api_id}.execute-api.{region}.amazonaws.com“ endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint

func (LookupRestApiResultOutput) ElementType added in v0.12.0 

func (LookupRestApiResultOutput) ElementType() reflect.Type

func (LookupRestApiResultOutput) EndpointConfiguration added in v0.12.0 

func (o LookupRestApiResultOutput) EndpointConfiguration() RestApiEndpointConfigurationPtrOutput

A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the “Parameters“ property.

func (LookupRestApiResultOutput) MinimumCompressionSize added in v0.12.0 

func (o LookupRestApiResultOutput) MinimumCompressionSize() pulumi.IntPtrOutput

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

func (LookupRestApiResultOutput) Name added in v0.12.0 

func (o LookupRestApiResultOutput) Name() pulumi.StringPtrOutput

The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.

func (LookupRestApiResultOutput) Policy added in v0.12.0 

func (o LookupRestApiResultOutput) Policy() pulumi.AnyOutput

A policy document that contains the permissions for the “RestApi“ resource. To set the ARN for the policy, use the “!Join“ intrinsic function with “""“ as delimiter and values of “"execute-api:/"“ and “"*"“.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.

func (LookupRestApiResultOutput) RestApiId added in v0.44.0 

func (o LookupRestApiResultOutput) RestApiId() pulumi.StringPtrOutput

func (LookupRestApiResultOutput) RootResourceId added in v0.12.0 

func (o LookupRestApiResultOutput) RootResourceId() pulumi.StringPtrOutput

func (LookupRestApiResultOutput) Tags added in v0.12.0 

func (o LookupRestApiResultOutput) Tags() aws.TagArrayOutput

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.

func (LookupRestApiResultOutput) ToLookupRestApiResultOutput added in v0.12.0 

func (o LookupRestApiResultOutput) ToLookupRestApiResultOutput() LookupRestApiResultOutput

func (LookupRestApiResultOutput) ToLookupRestApiResultOutputWithContext added in v0.12.0 

func (o LookupRestApiResultOutput) ToLookupRestApiResultOutputWithContext(ctx context.Context) LookupRestApiResultOutput

type LookupStageArgs added in v0.12.0 

type LookupStageArgs struct {
	// The string identifier of the associated RestApi.
	RestApiId string `pulumi:"restApiId"`
	// The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
	StageName string `pulumi:"stageName"`
}

type LookupStageOutputArgs added in v0.12.0 

type LookupStageOutputArgs struct {
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
	// The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
	StageName pulumi.StringInput `pulumi:"stageName"`
}

func (LookupStageOutputArgs) ElementType added in v0.12.0 

func (LookupStageOutputArgs) ElementType() reflect.Type

type LookupStageResult added in v0.12.0 

type LookupStageResult struct {
	// Access log settings, including the access log format and access log destination ARN.
	AccessLogSetting *StageAccessLogSetting `pulumi:"accessLogSetting"`
	// Specifies whether a cache cluster is enabled for the stage.
	CacheClusterEnabled *bool `pulumi:"cacheClusterEnabled"`
	// The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
	CacheClusterSize *string `pulumi:"cacheClusterSize"`
	// Settings for the canary deployment in this stage.
	CanarySetting *StageCanarySetting `pulumi:"canarySetting"`
	// The identifier of a client certificate for an API stage.
	ClientCertificateId *string `pulumi:"clientCertificateId"`
	// The identifier of the Deployment that the stage points to.
	DeploymentId *string `pulumi:"deploymentId"`
	// The stage's description.
	Description *string `pulumi:"description"`
	// The version of the associated API documentation.
	DocumentationVersion *string `pulumi:"documentationVersion"`
	// A map that defines the method settings for a Stage resource. Keys (designated as “/{method_setting_key“ below) are method paths defined as “{resource_path}/{http_method}“ for an individual method override, or “/\*/\*“ for overriding all methods in the stage.
	MethodSettings []StageMethodSetting `pulumi:"methodSettings"`
	// The collection of tags. Each tag element is associated with a given resource.
	Tags []aws.Tag `pulumi:"tags"`
	// Specifies whether active tracing with X-ray is enabled for the Stage.
	TracingEnabled *bool `pulumi:"tracingEnabled"`
	// A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: “[A-Za-z0-9-._~:/?#&=,]+“.
	Variables map[string]string `pulumi:"variables"`
}

func LookupStage added in v0.12.0 

func LookupStage(ctx *pulumi.Context, args *LookupStageArgs, opts ...pulumi.InvokeOption) (*LookupStageResult, error)

The “AWS::ApiGateway::Stage“ resource creates a stage for a deployment.

type LookupStageResultOutput added in v0.12.0 

type LookupStageResultOutput struct{ *pulumi.OutputState }

func LookupStageOutput added in v0.12.0 

func LookupStageOutput(ctx *pulumi.Context, args LookupStageOutputArgs, opts ...pulumi.InvokeOption) LookupStageResultOutput

func (LookupStageResultOutput) AccessLogSetting added in v0.12.0 

func (o LookupStageResultOutput) AccessLogSetting() StageAccessLogSettingPtrOutput

Access log settings, including the access log format and access log destination ARN.

func (LookupStageResultOutput) CacheClusterEnabled added in v0.12.0 

func (o LookupStageResultOutput) CacheClusterEnabled() pulumi.BoolPtrOutput

Specifies whether a cache cluster is enabled for the stage.

func (LookupStageResultOutput) CacheClusterSize added in v0.12.0 

func (o LookupStageResultOutput) CacheClusterSize() pulumi.StringPtrOutput

The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).

func (LookupStageResultOutput) CanarySetting added in v0.12.0 

func (o LookupStageResultOutput) CanarySetting() StageCanarySettingPtrOutput

Settings for the canary deployment in this stage.

func (LookupStageResultOutput) ClientCertificateId added in v0.12.0 

func (o LookupStageResultOutput) ClientCertificateId() pulumi.StringPtrOutput

The identifier of a client certificate for an API stage.

func (LookupStageResultOutput) DeploymentId added in v0.12.0 

func (o LookupStageResultOutput) DeploymentId() pulumi.StringPtrOutput

The identifier of the Deployment that the stage points to.

func (LookupStageResultOutput) Description added in v0.12.0 

func (o LookupStageResultOutput) Description() pulumi.StringPtrOutput

The stage's description.

func (LookupStageResultOutput) DocumentationVersion added in v0.12.0 

func (o LookupStageResultOutput) DocumentationVersion() pulumi.StringPtrOutput

The version of the associated API documentation.

func (LookupStageResultOutput) ElementType added in v0.12.0 

func (LookupStageResultOutput) ElementType() reflect.Type

func (LookupStageResultOutput) MethodSettings added in v0.12.0 

func (o LookupStageResultOutput) MethodSettings() StageMethodSettingArrayOutput

A map that defines the method settings for a Stage resource. Keys (designated as “/{method_setting_key“ below) are method paths defined as “{resource_path}/{http_method}“ for an individual method override, or “/\*/\*“ for overriding all methods in the stage.

func (LookupStageResultOutput) Tags added in v0.12.0 

func (o LookupStageResultOutput) Tags() aws.TagArrayOutput

The collection of tags. Each tag element is associated with a given resource.

func (LookupStageResultOutput) ToLookupStageResultOutput added in v0.12.0 

func (o LookupStageResultOutput) ToLookupStageResultOutput() LookupStageResultOutput

func (LookupStageResultOutput) ToLookupStageResultOutputWithContext added in v0.12.0 

func (o LookupStageResultOutput) ToLookupStageResultOutputWithContext(ctx context.Context) LookupStageResultOutput

func (LookupStageResultOutput) TracingEnabled added in v0.12.0 

func (o LookupStageResultOutput) TracingEnabled() pulumi.BoolPtrOutput

Specifies whether active tracing with X-ray is enabled for the Stage.

func (LookupStageResultOutput) Variables added in v0.12.0 

func (o LookupStageResultOutput) Variables() pulumi.StringMapOutput

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: “[A-Za-z0-9-._~:/?#&=,]+“.

type LookupUsagePlanArgs added in v0.12.0 

type LookupUsagePlanArgs struct {
	Id string `pulumi:"id"`
}

type LookupUsagePlanKeyArgs added in v0.12.0 

type LookupUsagePlanKeyArgs struct {
	Id string `pulumi:"id"`
}

type LookupUsagePlanKeyOutputArgs added in v0.12.0 

type LookupUsagePlanKeyOutputArgs struct {
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupUsagePlanKeyOutputArgs) ElementType added in v0.12.0 

func (LookupUsagePlanKeyOutputArgs) ElementType() reflect.Type

type LookupUsagePlanKeyResult added in v0.12.0 

type LookupUsagePlanKeyResult struct {
	Id *string `pulumi:"id"`
}

func LookupUsagePlanKey added in v0.12.0 

func LookupUsagePlanKey(ctx *pulumi.Context, args *LookupUsagePlanKeyArgs, opts ...pulumi.InvokeOption) (*LookupUsagePlanKeyResult, error)

The “AWS::ApiGateway::UsagePlanKey“ resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.

type LookupUsagePlanKeyResultOutput added in v0.12.0 

type LookupUsagePlanKeyResultOutput struct{ *pulumi.OutputState }

func LookupUsagePlanKeyOutput added in v0.12.0 

func LookupUsagePlanKeyOutput(ctx *pulumi.Context, args LookupUsagePlanKeyOutputArgs, opts ...pulumi.InvokeOption) LookupUsagePlanKeyResultOutput

func (LookupUsagePlanKeyResultOutput) ElementType added in v0.12.0 

func (LookupUsagePlanKeyResultOutput) ElementType() reflect.Type

func (LookupUsagePlanKeyResultOutput) Id added in v0.12.0 

func (o LookupUsagePlanKeyResultOutput) Id() pulumi.StringPtrOutput

func (LookupUsagePlanKeyResultOutput) ToLookupUsagePlanKeyResultOutput added in v0.12.0 

func (o LookupUsagePlanKeyResultOutput) ToLookupUsagePlanKeyResultOutput() LookupUsagePlanKeyResultOutput

func (LookupUsagePlanKeyResultOutput) ToLookupUsagePlanKeyResultOutputWithContext added in v0.12.0 

func (o LookupUsagePlanKeyResultOutput) ToLookupUsagePlanKeyResultOutputWithContext(ctx context.Context) LookupUsagePlanKeyResultOutput

type LookupUsagePlanOutputArgs added in v0.12.0 

type LookupUsagePlanOutputArgs struct {
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupUsagePlanOutputArgs) ElementType added in v0.12.0 

func (LookupUsagePlanOutputArgs) ElementType() reflect.Type

type LookupUsagePlanResult added in v0.12.0 

type LookupUsagePlanResult struct {
	// The associated API stages of a usage plan.
	ApiStages []UsagePlanApiStage `pulumi:"apiStages"`
	// The description of a usage plan.
	Description *string `pulumi:"description"`
	Id          *string `pulumi:"id"`
	// The target maximum number of permitted requests per a given unit time interval.
	Quota *UsagePlanQuotaSettings `pulumi:"quota"`
	// The collection of tags. Each tag element is associated with a given resource.
	Tags []aws.Tag `pulumi:"tags"`
	// A map containing method level throttling information for API stage in a usage plan.
	Throttle *UsagePlanThrottleSettings `pulumi:"throttle"`
	// The name of a usage plan.
	UsagePlanName *string `pulumi:"usagePlanName"`
}

func LookupUsagePlan added in v0.12.0 

func LookupUsagePlan(ctx *pulumi.Context, args *LookupUsagePlanArgs, opts ...pulumi.InvokeOption) (*LookupUsagePlanResult, error)

The “AWS::ApiGateway::UsagePlan“ resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*. 

In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.

type LookupUsagePlanResultOutput added in v0.12.0 

type LookupUsagePlanResultOutput struct{ *pulumi.OutputState }

func LookupUsagePlanOutput added in v0.12.0 

func LookupUsagePlanOutput(ctx *pulumi.Context, args LookupUsagePlanOutputArgs, opts ...pulumi.InvokeOption) LookupUsagePlanResultOutput

func (LookupUsagePlanResultOutput) ApiStages added in v0.12.0 

func (o LookupUsagePlanResultOutput) ApiStages() UsagePlanApiStageArrayOutput

The associated API stages of a usage plan.

func (LookupUsagePlanResultOutput) Description added in v0.12.0 

func (o LookupUsagePlanResultOutput) Description() pulumi.StringPtrOutput

The description of a usage plan.

func (LookupUsagePlanResultOutput) ElementType added in v0.12.0 

func (LookupUsagePlanResultOutput) ElementType() reflect.Type

func (LookupUsagePlanResultOutput) Id added in v0.12.0 

func (o LookupUsagePlanResultOutput) Id() pulumi.StringPtrOutput

func (LookupUsagePlanResultOutput) Quota added in v0.12.0 

func (o LookupUsagePlanResultOutput) Quota() UsagePlanQuotaSettingsPtrOutput

The target maximum number of permitted requests per a given unit time interval.

func (LookupUsagePlanResultOutput) Tags added in v0.12.0 

func (o LookupUsagePlanResultOutput) Tags() aws.TagArrayOutput

The collection of tags. Each tag element is associated with a given resource.

func (LookupUsagePlanResultOutput) Throttle added in v0.12.0 

func (o LookupUsagePlanResultOutput) Throttle() UsagePlanThrottleSettingsPtrOutput

A map containing method level throttling information for API stage in a usage plan.

func (LookupUsagePlanResultOutput) ToLookupUsagePlanResultOutput added in v0.12.0 

func (o LookupUsagePlanResultOutput) ToLookupUsagePlanResultOutput() LookupUsagePlanResultOutput

func (LookupUsagePlanResultOutput) ToLookupUsagePlanResultOutputWithContext added in v0.12.0 

func (o LookupUsagePlanResultOutput) ToLookupUsagePlanResultOutputWithContext(ctx context.Context) LookupUsagePlanResultOutput

func (LookupUsagePlanResultOutput) UsagePlanName added in v0.12.0 

func (o LookupUsagePlanResultOutput) UsagePlanName() pulumi.StringPtrOutput

The name of a usage plan.

type LookupVpcLinkArgs added in v0.12.0 

type LookupVpcLinkArgs struct {
	// The ID of the instance that backs VPC link.
	VpcLinkId string `pulumi:"vpcLinkId"`
}

type LookupVpcLinkOutputArgs added in v0.12.0 

type LookupVpcLinkOutputArgs struct {
	// The ID of the instance that backs VPC link.
	VpcLinkId pulumi.StringInput `pulumi:"vpcLinkId"`
}

func (LookupVpcLinkOutputArgs) ElementType added in v0.12.0 

func (LookupVpcLinkOutputArgs) ElementType() reflect.Type

type LookupVpcLinkResult added in v0.12.0 

type LookupVpcLinkResult struct {
	// A description of the VPC link.
	Description *string `pulumi:"description"`
	// A name for the VPC link.
	Name *string `pulumi:"name"`
	// An array of arbitrary tags (key-value pairs) to associate with the stage.
	Tags []aws.Tag `pulumi:"tags"`
	// The ID of the instance that backs VPC link.
	VpcLinkId *string `pulumi:"vpcLinkId"`
}
func LookupVpcLink(ctx *pulumi.Context, args *LookupVpcLinkArgs, opts ...pulumi.InvokeOption) (*LookupVpcLinkResult, error)

Schema for AWS ApiGateway VpcLink

type LookupVpcLinkResultOutput added in v0.12.0 

type LookupVpcLinkResultOutput struct{ *pulumi.OutputState }

func LookupVpcLinkOutput added in v0.12.0 

func LookupVpcLinkOutput(ctx *pulumi.Context, args LookupVpcLinkOutputArgs, opts ...pulumi.InvokeOption) LookupVpcLinkResultOutput

func (LookupVpcLinkResultOutput) Description added in v0.12.0 

func (o LookupVpcLinkResultOutput) Description() pulumi.StringPtrOutput

A description of the VPC link.

func (LookupVpcLinkResultOutput) ElementType added in v0.12.0 

func (LookupVpcLinkResultOutput) ElementType() reflect.Type

func (LookupVpcLinkResultOutput) Name added in v0.12.0 

func (o LookupVpcLinkResultOutput) Name() pulumi.StringPtrOutput

A name for the VPC link.

func (LookupVpcLinkResultOutput) Tags added in v0.12.0 

func (o LookupVpcLinkResultOutput) Tags() aws.TagArrayOutput

An array of arbitrary tags (key-value pairs) to associate with the stage.

func (LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutput added in v0.12.0 

func (o LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutput() LookupVpcLinkResultOutput

func (LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutputWithContext added in v0.12.0 

func (o LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutputWithContext(ctx context.Context) LookupVpcLinkResultOutput

func (LookupVpcLinkResultOutput) VpcLinkId added in v0.52.0 

func (o LookupVpcLinkResultOutput) VpcLinkId() pulumi.StringPtrOutput

The ID of the instance that backs VPC link.

type Method 

type Method struct {
	pulumi.CustomResourceState

	// A boolean flag specifying whether a valid ApiKey is required to invoke this method.
	ApiKeyRequired pulumi.BoolPtrOutput `pulumi:"apiKeyRequired"`
	// A list of authorization scopes configured on the method. The scopes are used with a “COGNITO_USER_POOLS“ authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
	AuthorizationScopes pulumi.StringArrayOutput `pulumi:"authorizationScopes"`
	// The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.
	//   If you specify the “AuthorizerId“ property, specify “CUSTOM“ or “COGNITO_USER_POOLS“ for this property.
	AuthorizationType MethodAuthorizationTypePtrOutput `pulumi:"authorizationType"`
	// The identifier of an authorizer to use on this method. The method's authorization type must be “CUSTOM“ or “COGNITO_USER_POOLS“.
	AuthorizerId pulumi.StringPtrOutput `pulumi:"authorizerId"`
	// The method's HTTP verb.
	HttpMethod pulumi.StringOutput `pulumi:"httpMethod"`
	// Represents an “HTTP“, “HTTP_PROXY“, “AWS“, “AWS_PROXY“, or Mock integration.
	Integration MethodIntegrationPtrOutput `pulumi:"integration"`
	// Gets a method response associated with a given HTTP status code.
	MethodResponses MethodResponseArrayOutput `pulumi:"methodResponses"`
	// A human-friendly operation identifier for the method. For example, you can assign the “operationName“ of “ListPets“ for the “GET /pets“ method in the “PetStore“ example.
	OperationName pulumi.StringPtrOutput `pulumi:"operationName"`
	// A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
	RequestModels pulumi.StringMapOutput `pulumi:"requestModels"`
	// A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of “method.request.{location}.{name}“, where “location“ is “querystring“, “path“, or “header“ and “name“ is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (“true“) or optional (“false“). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
	RequestParameters pulumi.MapOutput `pulumi:"requestParameters"`
	// The identifier of a RequestValidator for request validation.
	RequestValidatorId pulumi.StringPtrOutput `pulumi:"requestValidatorId"`
	// The Resource identifier for the MethodResponse resource.
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
}

The “AWS::ApiGateway::Method“ resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

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.

func (*Method) ElementType 

func (*Method) ElementType() reflect.Type

func (*Method) ToMethodOutput 

func (i *Method) ToMethodOutput() MethodOutput

func (*Method) ToMethodOutputWithContext 

func (i *Method) ToMethodOutputWithContext(ctx context.Context) MethodOutput

type MethodArgs 

type MethodArgs struct {
	// A boolean flag specifying whether a valid ApiKey is required to invoke this method.
	ApiKeyRequired pulumi.BoolPtrInput
	// A list of authorization scopes configured on the method. The scopes are used with a “COGNITO_USER_POOLS“ authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
	AuthorizationScopes pulumi.StringArrayInput
	// The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.
	//   If you specify the “AuthorizerId“ property, specify “CUSTOM“ or “COGNITO_USER_POOLS“ for this property.
	AuthorizationType MethodAuthorizationTypePtrInput
	// The identifier of an authorizer to use on this method. The method's authorization type must be “CUSTOM“ or “COGNITO_USER_POOLS“.
	AuthorizerId pulumi.StringPtrInput
	// The method's HTTP verb.
	HttpMethod pulumi.StringInput
	// Represents an “HTTP“, “HTTP_PROXY“, “AWS“, “AWS_PROXY“, or Mock integration.
	Integration MethodIntegrationPtrInput
	// Gets a method response associated with a given HTTP status code.
	MethodResponses MethodResponseArrayInput
	// A human-friendly operation identifier for the method. For example, you can assign the “operationName“ of “ListPets“ for the “GET /pets“ method in the “PetStore“ example.
	OperationName pulumi.StringPtrInput
	// A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
	RequestModels pulumi.StringMapInput
	// A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of “method.request.{location}.{name}“, where “location“ is “querystring“, “path“, or “header“ and “name“ is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (“true“) or optional (“false“). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
	RequestParameters pulumi.MapInput
	// The identifier of a RequestValidator for request validation.
	RequestValidatorId pulumi.StringPtrInput
	// The Resource identifier for the MethodResponse resource.
	ResourceId pulumi.StringInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput
}

The set of arguments for constructing a Method resource.

func (MethodArgs) ElementType 

func (MethodArgs) ElementType() reflect.Type

type MethodAuthorizationType added in v0.2.0 

type MethodAuthorizationType string

The method's authorization type. This parameter is required. For valid values, see Method(https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. 

If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.

func (MethodAuthorizationType) ElementType added in v0.2.0 

func (MethodAuthorizationType) ElementType() reflect.Type

func (MethodAuthorizationType) ToMethodAuthorizationTypeOutput added in v0.2.0 

func (e MethodAuthorizationType) ToMethodAuthorizationTypeOutput() MethodAuthorizationTypeOutput

func (MethodAuthorizationType) ToMethodAuthorizationTypeOutputWithContext added in v0.2.0 

func (e MethodAuthorizationType) ToMethodAuthorizationTypeOutputWithContext(ctx context.Context) MethodAuthorizationTypeOutput

func (MethodAuthorizationType) ToMethodAuthorizationTypePtrOutput added in v0.2.0 

func (e MethodAuthorizationType) ToMethodAuthorizationTypePtrOutput() MethodAuthorizationTypePtrOutput

func (MethodAuthorizationType) ToMethodAuthorizationTypePtrOutputWithContext added in v0.2.0 

func (e MethodAuthorizationType) ToMethodAuthorizationTypePtrOutputWithContext(ctx context.Context) MethodAuthorizationTypePtrOutput

func (MethodAuthorizationType) ToStringOutput added in v0.2.0 

func (e MethodAuthorizationType) ToStringOutput() pulumi.StringOutput

func (MethodAuthorizationType) ToStringOutputWithContext added in v0.2.0 

func (e MethodAuthorizationType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodAuthorizationType) ToStringPtrOutput added in v0.2.0 

func (e MethodAuthorizationType) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodAuthorizationType) ToStringPtrOutputWithContext added in v0.2.0 

func (e MethodAuthorizationType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodAuthorizationTypeInput added in v0.2.0 

type MethodAuthorizationTypeInput interface {
	pulumi.Input

	ToMethodAuthorizationTypeOutput() MethodAuthorizationTypeOutput
	ToMethodAuthorizationTypeOutputWithContext(context.Context) MethodAuthorizationTypeOutput
}

MethodAuthorizationTypeInput is an input type that accepts values of the MethodAuthorizationType enum A concrete instance of `MethodAuthorizationTypeInput` can be one of the following: 

MethodAuthorizationTypeNone
MethodAuthorizationTypeAwsIam
MethodAuthorizationTypeCustom
MethodAuthorizationTypeCognitoUserPools

type MethodAuthorizationTypeOutput added in v0.2.0 

type MethodAuthorizationTypeOutput struct{ *pulumi.OutputState }

func (MethodAuthorizationTypeOutput) ElementType added in v0.2.0 

func (MethodAuthorizationTypeOutput) ElementType() reflect.Type

func (MethodAuthorizationTypeOutput) ToMethodAuthorizationTypeOutput added in v0.2.0 

func (o MethodAuthorizationTypeOutput) ToMethodAuthorizationTypeOutput() MethodAuthorizationTypeOutput

func (MethodAuthorizationTypeOutput) ToMethodAuthorizationTypeOutputWithContext added in v0.2.0 

func (o MethodAuthorizationTypeOutput) ToMethodAuthorizationTypeOutputWithContext(ctx context.Context) MethodAuthorizationTypeOutput

func (MethodAuthorizationTypeOutput) ToMethodAuthorizationTypePtrOutput added in v0.2.0 

func (o MethodAuthorizationTypeOutput) ToMethodAuthorizationTypePtrOutput() MethodAuthorizationTypePtrOutput

func (MethodAuthorizationTypeOutput) ToMethodAuthorizationTypePtrOutputWithContext added in v0.2.0 

func (o MethodAuthorizationTypeOutput) ToMethodAuthorizationTypePtrOutputWithContext(ctx context.Context) MethodAuthorizationTypePtrOutput

func (MethodAuthorizationTypeOutput) ToStringOutput added in v0.2.0 

func (o MethodAuthorizationTypeOutput) ToStringOutput() pulumi.StringOutput

func (MethodAuthorizationTypeOutput) ToStringOutputWithContext added in v0.2.0 

func (o MethodAuthorizationTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodAuthorizationTypeOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodAuthorizationTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodAuthorizationTypeOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodAuthorizationTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodAuthorizationTypePtrInput added in v0.2.0 

type MethodAuthorizationTypePtrInput interface {
	pulumi.Input

	ToMethodAuthorizationTypePtrOutput() MethodAuthorizationTypePtrOutput
	ToMethodAuthorizationTypePtrOutputWithContext(context.Context) MethodAuthorizationTypePtrOutput
}

func MethodAuthorizationTypePtr added in v0.2.0 

func MethodAuthorizationTypePtr(v string) MethodAuthorizationTypePtrInput

type MethodAuthorizationTypePtrOutput added in v0.2.0 

type MethodAuthorizationTypePtrOutput struct{ *pulumi.OutputState }

func (MethodAuthorizationTypePtrOutput) Elem added in v0.2.0 

func (o MethodAuthorizationTypePtrOutput) Elem() MethodAuthorizationTypeOutput

func (MethodAuthorizationTypePtrOutput) ElementType added in v0.2.0 

func (MethodAuthorizationTypePtrOutput) ElementType() reflect.Type

func (MethodAuthorizationTypePtrOutput) ToMethodAuthorizationTypePtrOutput added in v0.2.0 

func (o MethodAuthorizationTypePtrOutput) ToMethodAuthorizationTypePtrOutput() MethodAuthorizationTypePtrOutput

func (MethodAuthorizationTypePtrOutput) ToMethodAuthorizationTypePtrOutputWithContext added in v0.2.0 

func (o MethodAuthorizationTypePtrOutput) ToMethodAuthorizationTypePtrOutputWithContext(ctx context.Context) MethodAuthorizationTypePtrOutput

func (MethodAuthorizationTypePtrOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodAuthorizationTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodAuthorizationTypePtrOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodAuthorizationTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodInput 

type MethodInput interface {
	pulumi.Input

	ToMethodOutput() MethodOutput
	ToMethodOutputWithContext(ctx context.Context) MethodOutput
}

type MethodIntegration 

type MethodIntegration struct {
	// A list of request parameters whose values API Gateway caches. To be valid values for “cacheKeyParameters“, these parameters must also be specified for Method “requestParameters“.
	CacheKeyParameters []string `pulumi:"cacheKeyParameters"`
	// Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the “cacheNamespace“. You can specify the same “cacheNamespace“ across resources to return the same cached data for requests to different resources.
	CacheNamespace *string `pulumi:"cacheNamespace"`
	// The ID of the VpcLink used for the integration when “connectionType=VPC_LINK“ and undefined, otherwise.
	ConnectionId *string `pulumi:"connectionId"`
	// The type of the network connection to the integration endpoint. The valid value is “INTERNET“ for connections through the public routable internet or “VPC_LINK“ for private connections between API Gateway and a network load balancer in a VPC. The default value is “INTERNET“.
	ConnectionType *MethodIntegrationConnectionType `pulumi:"connectionType"`
	// Specifies how to handle request payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors:
	//  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 “passthroughBehavior“ is configured to support payload pass-through.
	ContentHandling *MethodIntegrationContentHandling `pulumi:"contentHandling"`
	// Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string “arn:aws:iam::\*:user/\*“. To use resource-based permissions on supported AWS services, specify null.
	Credentials *string `pulumi:"credentials"`
	// Specifies the integration's HTTP method type. For the Type property, if you specify “MOCK“, this property is optional. For Lambda integrations, you must set the integration method to “POST“. For all other types, you must specify this property.
	IntegrationHttpMethod *string `pulumi:"integrationHttpMethod"`
	// Specifies the integration's responses.
	IntegrationResponses []MethodIntegrationResponse `pulumi:"integrationResponses"`
	// Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in “requestTemplates“. The valid value is one of the following: “WHEN_NO_MATCH“: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. “WHEN_NO_TEMPLATES“: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. “NEVER“: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
	PassthroughBehavior *MethodIntegrationPassthroughBehavior `pulumi:"passthroughBehavior"`
	// A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of “method.request.{location}.{name}“, where “location“ is “querystring“, “path“, or “header“ and “name“ must be a valid and unique method request parameter name.
	RequestParameters map[string]string `pulumi:"requestParameters"`
	// Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
	RequestTemplates map[string]string `pulumi:"requestTemplates"`
	// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
	TimeoutInMillis *int `pulumi:"timeoutInMillis"`
	// Specifies an API method integration type. The valid value is one of the following:
	//  For the HTTP and HTTP proxy integrations, each integration can specify a protocol (“http/https“), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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 MethodIntegrationType `pulumi:"type"`
	// Specifies Uniform Resource Identifier (URI) of the integration endpoint.
	//  For “HTTP“ or “HTTP_PROXY“ integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If “connectionType“ is “VPC_LINK“ specify the Network Load Balancer DNS name. For “AWS“ or “AWS_PROXY“ integrations, the URI is of the form “arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}“. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either “arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}“ or “arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}“
	Uri *string `pulumi:"uri"`
}

“Integration“ is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.

type MethodIntegrationArgs 

type MethodIntegrationArgs struct {
	// A list of request parameters whose values API Gateway caches. To be valid values for “cacheKeyParameters“, these parameters must also be specified for Method “requestParameters“.
	CacheKeyParameters pulumi.StringArrayInput `pulumi:"cacheKeyParameters"`
	// Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the “cacheNamespace“. You can specify the same “cacheNamespace“ across resources to return the same cached data for requests to different resources.
	CacheNamespace pulumi.StringPtrInput `pulumi:"cacheNamespace"`
	// The ID of the VpcLink used for the integration when “connectionType=VPC_LINK“ and undefined, otherwise.
	ConnectionId pulumi.StringPtrInput `pulumi:"connectionId"`
	// The type of the network connection to the integration endpoint. The valid value is “INTERNET“ for connections through the public routable internet or “VPC_LINK“ for private connections between API Gateway and a network load balancer in a VPC. The default value is “INTERNET“.
	ConnectionType MethodIntegrationConnectionTypePtrInput `pulumi:"connectionType"`
	// Specifies how to handle request payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors:
	//  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 “passthroughBehavior“ is configured to support payload pass-through.
	ContentHandling MethodIntegrationContentHandlingPtrInput `pulumi:"contentHandling"`
	// Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string “arn:aws:iam::\*:user/\*“. To use resource-based permissions on supported AWS services, specify null.
	Credentials pulumi.StringPtrInput `pulumi:"credentials"`
	// Specifies the integration's HTTP method type. For the Type property, if you specify “MOCK“, this property is optional. For Lambda integrations, you must set the integration method to “POST“. For all other types, you must specify this property.
	IntegrationHttpMethod pulumi.StringPtrInput `pulumi:"integrationHttpMethod"`
	// Specifies the integration's responses.
	IntegrationResponses MethodIntegrationResponseArrayInput `pulumi:"integrationResponses"`
	// Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in “requestTemplates“. The valid value is one of the following: “WHEN_NO_MATCH“: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. “WHEN_NO_TEMPLATES“: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. “NEVER“: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
	PassthroughBehavior MethodIntegrationPassthroughBehaviorPtrInput `pulumi:"passthroughBehavior"`
	// A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of “method.request.{location}.{name}“, where “location“ is “querystring“, “path“, or “header“ and “name“ must be a valid and unique method request parameter name.
	RequestParameters pulumi.StringMapInput `pulumi:"requestParameters"`
	// Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
	RequestTemplates pulumi.StringMapInput `pulumi:"requestTemplates"`
	// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
	TimeoutInMillis pulumi.IntPtrInput `pulumi:"timeoutInMillis"`
	// Specifies an API method integration type. The valid value is one of the following:
	//  For the HTTP and HTTP proxy integrations, each integration can specify a protocol (“http/https“), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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 MethodIntegrationTypeInput `pulumi:"type"`
	// Specifies Uniform Resource Identifier (URI) of the integration endpoint.
	//  For “HTTP“ or “HTTP_PROXY“ integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If “connectionType“ is “VPC_LINK“ specify the Network Load Balancer DNS name. For “AWS“ or “AWS_PROXY“ integrations, the URI is of the form “arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}“. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either “arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}“ or “arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}“
	Uri pulumi.StringPtrInput `pulumi:"uri"`
}

“Integration“ is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.

func (MethodIntegrationArgs) ElementType 

func (MethodIntegrationArgs) ElementType() reflect.Type

func (MethodIntegrationArgs) ToMethodIntegrationOutput 

func (i MethodIntegrationArgs) ToMethodIntegrationOutput() MethodIntegrationOutput

func (MethodIntegrationArgs) ToMethodIntegrationOutputWithContext 

func (i MethodIntegrationArgs) ToMethodIntegrationOutputWithContext(ctx context.Context) MethodIntegrationOutput

func (MethodIntegrationArgs) ToMethodIntegrationPtrOutput 

func (i MethodIntegrationArgs) ToMethodIntegrationPtrOutput() MethodIntegrationPtrOutput

func (MethodIntegrationArgs) ToMethodIntegrationPtrOutputWithContext 

func (i MethodIntegrationArgs) ToMethodIntegrationPtrOutputWithContext(ctx context.Context) MethodIntegrationPtrOutput

type MethodIntegrationConnectionType added in v0.2.0 

type MethodIntegrationConnectionType string

The type of the network connection to the integration endpoint. The valid value is “INTERNET“ for connections through the public routable internet or “VPC_LINK“ for private connections between API Gateway and a network load balancer in a VPC. The default value is “INTERNET“.

func (MethodIntegrationConnectionType) ElementType added in v0.2.0 

func (MethodIntegrationConnectionType) ElementType() reflect.Type

func (MethodIntegrationConnectionType) ToMethodIntegrationConnectionTypeOutput added in v0.2.0 

func (e MethodIntegrationConnectionType) ToMethodIntegrationConnectionTypeOutput() MethodIntegrationConnectionTypeOutput

func (MethodIntegrationConnectionType) ToMethodIntegrationConnectionTypeOutputWithContext added in v0.2.0 

func (e MethodIntegrationConnectionType) ToMethodIntegrationConnectionTypeOutputWithContext(ctx context.Context) MethodIntegrationConnectionTypeOutput

func (MethodIntegrationConnectionType) ToMethodIntegrationConnectionTypePtrOutput added in v0.2.0 

func (e MethodIntegrationConnectionType) ToMethodIntegrationConnectionTypePtrOutput() MethodIntegrationConnectionTypePtrOutput

func (MethodIntegrationConnectionType) ToMethodIntegrationConnectionTypePtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationConnectionType) ToMethodIntegrationConnectionTypePtrOutputWithContext(ctx context.Context) MethodIntegrationConnectionTypePtrOutput

func (MethodIntegrationConnectionType) ToStringOutput added in v0.2.0 

func (e MethodIntegrationConnectionType) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationConnectionType) ToStringOutputWithContext added in v0.2.0 

func (e MethodIntegrationConnectionType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationConnectionType) ToStringPtrOutput added in v0.2.0 

func (e MethodIntegrationConnectionType) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationConnectionType) ToStringPtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationConnectionType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationConnectionTypeInput added in v0.2.0 

type MethodIntegrationConnectionTypeInput interface {
	pulumi.Input

	ToMethodIntegrationConnectionTypeOutput() MethodIntegrationConnectionTypeOutput
	ToMethodIntegrationConnectionTypeOutputWithContext(context.Context) MethodIntegrationConnectionTypeOutput
}

MethodIntegrationConnectionTypeInput is an input type that accepts values of the MethodIntegrationConnectionType enum A concrete instance of `MethodIntegrationConnectionTypeInput` can be one of the following: 

MethodIntegrationConnectionTypeInternet
MethodIntegrationConnectionTypeVpcLink

type MethodIntegrationConnectionTypeOutput added in v0.2.0 

type MethodIntegrationConnectionTypeOutput struct{ *pulumi.OutputState }

func (MethodIntegrationConnectionTypeOutput) ElementType added in v0.2.0 

func (MethodIntegrationConnectionTypeOutput) ElementType() reflect.Type

func (MethodIntegrationConnectionTypeOutput) ToMethodIntegrationConnectionTypeOutput added in v0.2.0 

func (o MethodIntegrationConnectionTypeOutput) ToMethodIntegrationConnectionTypeOutput() MethodIntegrationConnectionTypeOutput

func (MethodIntegrationConnectionTypeOutput) ToMethodIntegrationConnectionTypeOutputWithContext added in v0.2.0 

func (o MethodIntegrationConnectionTypeOutput) ToMethodIntegrationConnectionTypeOutputWithContext(ctx context.Context) MethodIntegrationConnectionTypeOutput

func (MethodIntegrationConnectionTypeOutput) ToMethodIntegrationConnectionTypePtrOutput added in v0.2.0 

func (o MethodIntegrationConnectionTypeOutput) ToMethodIntegrationConnectionTypePtrOutput() MethodIntegrationConnectionTypePtrOutput

func (MethodIntegrationConnectionTypeOutput) ToMethodIntegrationConnectionTypePtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationConnectionTypeOutput) ToMethodIntegrationConnectionTypePtrOutputWithContext(ctx context.Context) MethodIntegrationConnectionTypePtrOutput

func (MethodIntegrationConnectionTypeOutput) ToStringOutput added in v0.2.0 

func (o MethodIntegrationConnectionTypeOutput) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationConnectionTypeOutput) ToStringOutputWithContext added in v0.2.0 

func (o MethodIntegrationConnectionTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationConnectionTypeOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationConnectionTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationConnectionTypeOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationConnectionTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationConnectionTypePtrInput added in v0.2.0 

type MethodIntegrationConnectionTypePtrInput interface {
	pulumi.Input

	ToMethodIntegrationConnectionTypePtrOutput() MethodIntegrationConnectionTypePtrOutput
	ToMethodIntegrationConnectionTypePtrOutputWithContext(context.Context) MethodIntegrationConnectionTypePtrOutput
}

func MethodIntegrationConnectionTypePtr added in v0.2.0 

func MethodIntegrationConnectionTypePtr(v string) MethodIntegrationConnectionTypePtrInput

type MethodIntegrationConnectionTypePtrOutput added in v0.2.0 

type MethodIntegrationConnectionTypePtrOutput struct{ *pulumi.OutputState }

func (MethodIntegrationConnectionTypePtrOutput) Elem added in v0.2.0 

func (o MethodIntegrationConnectionTypePtrOutput) Elem() MethodIntegrationConnectionTypeOutput

func (MethodIntegrationConnectionTypePtrOutput) ElementType added in v0.2.0 

func (MethodIntegrationConnectionTypePtrOutput) ElementType() reflect.Type

func (MethodIntegrationConnectionTypePtrOutput) ToMethodIntegrationConnectionTypePtrOutput added in v0.2.0 

func (o MethodIntegrationConnectionTypePtrOutput) ToMethodIntegrationConnectionTypePtrOutput() MethodIntegrationConnectionTypePtrOutput

func (MethodIntegrationConnectionTypePtrOutput) ToMethodIntegrationConnectionTypePtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationConnectionTypePtrOutput) ToMethodIntegrationConnectionTypePtrOutputWithContext(ctx context.Context) MethodIntegrationConnectionTypePtrOutput

func (MethodIntegrationConnectionTypePtrOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationConnectionTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationConnectionTypePtrOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationConnectionTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationContentHandling added in v0.2.0 

type MethodIntegrationContentHandling string

Specifies how to handle request payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors: 

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 ``passthroughBehavior`` is configured to support payload pass-through.

func (MethodIntegrationContentHandling) ElementType added in v0.2.0 

func (MethodIntegrationContentHandling) ElementType() reflect.Type

func (MethodIntegrationContentHandling) ToMethodIntegrationContentHandlingOutput added in v0.2.0 

func (e MethodIntegrationContentHandling) ToMethodIntegrationContentHandlingOutput() MethodIntegrationContentHandlingOutput

func (MethodIntegrationContentHandling) ToMethodIntegrationContentHandlingOutputWithContext added in v0.2.0 

func (e MethodIntegrationContentHandling) ToMethodIntegrationContentHandlingOutputWithContext(ctx context.Context) MethodIntegrationContentHandlingOutput

func (MethodIntegrationContentHandling) ToMethodIntegrationContentHandlingPtrOutput added in v0.2.0 

func (e MethodIntegrationContentHandling) ToMethodIntegrationContentHandlingPtrOutput() MethodIntegrationContentHandlingPtrOutput

func (MethodIntegrationContentHandling) ToMethodIntegrationContentHandlingPtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationContentHandling) ToMethodIntegrationContentHandlingPtrOutputWithContext(ctx context.Context) MethodIntegrationContentHandlingPtrOutput

func (MethodIntegrationContentHandling) ToStringOutput added in v0.2.0 

func (e MethodIntegrationContentHandling) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationContentHandling) ToStringOutputWithContext added in v0.2.0 

func (e MethodIntegrationContentHandling) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationContentHandling) ToStringPtrOutput added in v0.2.0 

func (e MethodIntegrationContentHandling) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationContentHandling) ToStringPtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationContentHandling) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationContentHandlingInput added in v0.2.0 

type MethodIntegrationContentHandlingInput interface {
	pulumi.Input

	ToMethodIntegrationContentHandlingOutput() MethodIntegrationContentHandlingOutput
	ToMethodIntegrationContentHandlingOutputWithContext(context.Context) MethodIntegrationContentHandlingOutput
}

MethodIntegrationContentHandlingInput is an input type that accepts values of the MethodIntegrationContentHandling enum A concrete instance of `MethodIntegrationContentHandlingInput` can be one of the following: 

MethodIntegrationContentHandlingConvertToBinary
MethodIntegrationContentHandlingConvertToText

type MethodIntegrationContentHandlingOutput added in v0.2.0 

type MethodIntegrationContentHandlingOutput struct{ *pulumi.OutputState }

func (MethodIntegrationContentHandlingOutput) ElementType added in v0.2.0 

func (MethodIntegrationContentHandlingOutput) ElementType() reflect.Type

func (MethodIntegrationContentHandlingOutput) ToMethodIntegrationContentHandlingOutput added in v0.2.0 

func (o MethodIntegrationContentHandlingOutput) ToMethodIntegrationContentHandlingOutput() MethodIntegrationContentHandlingOutput

func (MethodIntegrationContentHandlingOutput) ToMethodIntegrationContentHandlingOutputWithContext added in v0.2.0 

func (o MethodIntegrationContentHandlingOutput) ToMethodIntegrationContentHandlingOutputWithContext(ctx context.Context) MethodIntegrationContentHandlingOutput

func (MethodIntegrationContentHandlingOutput) ToMethodIntegrationContentHandlingPtrOutput added in v0.2.0 

func (o MethodIntegrationContentHandlingOutput) ToMethodIntegrationContentHandlingPtrOutput() MethodIntegrationContentHandlingPtrOutput

func (MethodIntegrationContentHandlingOutput) ToMethodIntegrationContentHandlingPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationContentHandlingOutput) ToMethodIntegrationContentHandlingPtrOutputWithContext(ctx context.Context) MethodIntegrationContentHandlingPtrOutput

func (MethodIntegrationContentHandlingOutput) ToStringOutput added in v0.2.0 

func (o MethodIntegrationContentHandlingOutput) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationContentHandlingOutput) ToStringOutputWithContext added in v0.2.0 

func (o MethodIntegrationContentHandlingOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationContentHandlingOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationContentHandlingOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationContentHandlingOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationContentHandlingOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationContentHandlingPtrInput added in v0.2.0 

type MethodIntegrationContentHandlingPtrInput interface {
	pulumi.Input

	ToMethodIntegrationContentHandlingPtrOutput() MethodIntegrationContentHandlingPtrOutput
	ToMethodIntegrationContentHandlingPtrOutputWithContext(context.Context) MethodIntegrationContentHandlingPtrOutput
}

func MethodIntegrationContentHandlingPtr added in v0.2.0 

func MethodIntegrationContentHandlingPtr(v string) MethodIntegrationContentHandlingPtrInput

type MethodIntegrationContentHandlingPtrOutput added in v0.2.0 

type MethodIntegrationContentHandlingPtrOutput struct{ *pulumi.OutputState }

func (MethodIntegrationContentHandlingPtrOutput) Elem added in v0.2.0 

func (o MethodIntegrationContentHandlingPtrOutput) Elem() MethodIntegrationContentHandlingOutput

func (MethodIntegrationContentHandlingPtrOutput) ElementType added in v0.2.0 

func (MethodIntegrationContentHandlingPtrOutput) ElementType() reflect.Type

func (MethodIntegrationContentHandlingPtrOutput) ToMethodIntegrationContentHandlingPtrOutput added in v0.2.0 

func (o MethodIntegrationContentHandlingPtrOutput) ToMethodIntegrationContentHandlingPtrOutput() MethodIntegrationContentHandlingPtrOutput

func (MethodIntegrationContentHandlingPtrOutput) ToMethodIntegrationContentHandlingPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationContentHandlingPtrOutput) ToMethodIntegrationContentHandlingPtrOutputWithContext(ctx context.Context) MethodIntegrationContentHandlingPtrOutput

func (MethodIntegrationContentHandlingPtrOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationContentHandlingPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationContentHandlingPtrOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationContentHandlingPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationInput 

type MethodIntegrationInput interface {
	pulumi.Input

	ToMethodIntegrationOutput() MethodIntegrationOutput
	ToMethodIntegrationOutputWithContext(context.Context) MethodIntegrationOutput
}

MethodIntegrationInput is an input type that accepts MethodIntegrationArgs and MethodIntegrationOutput values. You can construct a concrete instance of `MethodIntegrationInput` via: 

MethodIntegrationArgs{...}

type MethodIntegrationOutput 

type MethodIntegrationOutput struct{ *pulumi.OutputState }

“Integration“ is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.

func (MethodIntegrationOutput) CacheKeyParameters 

func (o MethodIntegrationOutput) CacheKeyParameters() pulumi.StringArrayOutput

A list of request parameters whose values API Gateway caches. To be valid values for “cacheKeyParameters“, these parameters must also be specified for Method “requestParameters“.

func (MethodIntegrationOutput) CacheNamespace 

func (o MethodIntegrationOutput) CacheNamespace() pulumi.StringPtrOutput

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the “cacheNamespace“. You can specify the same “cacheNamespace“ across resources to return the same cached data for requests to different resources.

func (MethodIntegrationOutput) ConnectionId 

func (o MethodIntegrationOutput) ConnectionId() pulumi.StringPtrOutput

The ID of the VpcLink used for the integration when “connectionType=VPC_LINK“ and undefined, otherwise.

func (MethodIntegrationOutput) ConnectionType 

func (o MethodIntegrationOutput) ConnectionType() MethodIntegrationConnectionTypePtrOutput

The type of the network connection to the integration endpoint. The valid value is “INTERNET“ for connections through the public routable internet or “VPC_LINK“ for private connections between API Gateway and a network load balancer in a VPC. The default value is “INTERNET“.

func (MethodIntegrationOutput) ContentHandling 

func (o MethodIntegrationOutput) ContentHandling() MethodIntegrationContentHandlingPtrOutput

Specifies how to handle request payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors: 

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 ``passthroughBehavior`` is configured to support payload pass-through.

func (MethodIntegrationOutput) Credentials 

func (o MethodIntegrationOutput) Credentials() pulumi.StringPtrOutput

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string “arn:aws:iam::\*:user/\*“. To use resource-based permissions on supported AWS services, specify null.

func (MethodIntegrationOutput) ElementType 

func (MethodIntegrationOutput) ElementType() reflect.Type

func (MethodIntegrationOutput) IntegrationHttpMethod 

func (o MethodIntegrationOutput) IntegrationHttpMethod() pulumi.StringPtrOutput

Specifies the integration's HTTP method type. For the Type property, if you specify “MOCK“, this property is optional. For Lambda integrations, you must set the integration method to “POST“. For all other types, you must specify this property.

func (MethodIntegrationOutput) IntegrationResponses 

func (o MethodIntegrationOutput) IntegrationResponses() MethodIntegrationResponseArrayOutput

Specifies the integration's responses.

func (MethodIntegrationOutput) PassthroughBehavior 

func (o MethodIntegrationOutput) PassthroughBehavior() MethodIntegrationPassthroughBehaviorPtrOutput

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in “requestTemplates“. The valid value is one of the following: “WHEN_NO_MATCH“: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. “WHEN_NO_TEMPLATES“: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. “NEVER“: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

func (MethodIntegrationOutput) RequestParameters 

func (o MethodIntegrationOutput) RequestParameters() pulumi.StringMapOutput

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of “method.request.{location}.{name}“, where “location“ is “querystring“, “path“, or “header“ and “name“ must be a valid and unique method request parameter name.

func (MethodIntegrationOutput) RequestTemplates 

func (o MethodIntegrationOutput) RequestTemplates() pulumi.StringMapOutput

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

func (MethodIntegrationOutput) TimeoutInMillis 

func (o MethodIntegrationOutput) TimeoutInMillis() pulumi.IntPtrOutput

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

func (MethodIntegrationOutput) ToMethodIntegrationOutput 

func (o MethodIntegrationOutput) ToMethodIntegrationOutput() MethodIntegrationOutput

func (MethodIntegrationOutput) ToMethodIntegrationOutputWithContext 

func (o MethodIntegrationOutput) ToMethodIntegrationOutputWithContext(ctx context.Context) MethodIntegrationOutput

func (MethodIntegrationOutput) ToMethodIntegrationPtrOutput 

func (o MethodIntegrationOutput) ToMethodIntegrationPtrOutput() MethodIntegrationPtrOutput

func (MethodIntegrationOutput) ToMethodIntegrationPtrOutputWithContext 

func (o MethodIntegrationOutput) ToMethodIntegrationPtrOutputWithContext(ctx context.Context) MethodIntegrationPtrOutput

func (MethodIntegrationOutput) Type 

func (o MethodIntegrationOutput) Type() MethodIntegrationTypeOutput

Specifies an API method integration type. The valid value is one of the following: 

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (``http/https``), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.

func (MethodIntegrationOutput) Uri 

func (o MethodIntegrationOutput) Uri() pulumi.StringPtrOutput

Specifies Uniform Resource Identifier (URI) of the integration endpoint. 

For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}``

type MethodIntegrationPassthroughBehavior added in v0.2.0 

type MethodIntegrationPassthroughBehavior string

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in “requestTemplates“. The valid value is one of the following: “WHEN_NO_MATCH“: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. “WHEN_NO_TEMPLATES“: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. “NEVER“: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

func (MethodIntegrationPassthroughBehavior) ElementType added in v0.2.0 

func (MethodIntegrationPassthroughBehavior) ElementType() reflect.Type

func (MethodIntegrationPassthroughBehavior) ToMethodIntegrationPassthroughBehaviorOutput added in v0.2.0 

func (e MethodIntegrationPassthroughBehavior) ToMethodIntegrationPassthroughBehaviorOutput() MethodIntegrationPassthroughBehaviorOutput

func (MethodIntegrationPassthroughBehavior) ToMethodIntegrationPassthroughBehaviorOutputWithContext added in v0.2.0 

func (e MethodIntegrationPassthroughBehavior) ToMethodIntegrationPassthroughBehaviorOutputWithContext(ctx context.Context) MethodIntegrationPassthroughBehaviorOutput

func (MethodIntegrationPassthroughBehavior) ToMethodIntegrationPassthroughBehaviorPtrOutput added in v0.2.0 

func (e MethodIntegrationPassthroughBehavior) ToMethodIntegrationPassthroughBehaviorPtrOutput() MethodIntegrationPassthroughBehaviorPtrOutput

func (MethodIntegrationPassthroughBehavior) ToMethodIntegrationPassthroughBehaviorPtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationPassthroughBehavior) ToMethodIntegrationPassthroughBehaviorPtrOutputWithContext(ctx context.Context) MethodIntegrationPassthroughBehaviorPtrOutput

func (MethodIntegrationPassthroughBehavior) ToStringOutput added in v0.2.0 

func (e MethodIntegrationPassthroughBehavior) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationPassthroughBehavior) ToStringOutputWithContext added in v0.2.0 

func (e MethodIntegrationPassthroughBehavior) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationPassthroughBehavior) ToStringPtrOutput added in v0.2.0 

func (e MethodIntegrationPassthroughBehavior) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationPassthroughBehavior) ToStringPtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationPassthroughBehavior) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationPassthroughBehaviorInput added in v0.2.0 

type MethodIntegrationPassthroughBehaviorInput interface {
	pulumi.Input

	ToMethodIntegrationPassthroughBehaviorOutput() MethodIntegrationPassthroughBehaviorOutput
	ToMethodIntegrationPassthroughBehaviorOutputWithContext(context.Context) MethodIntegrationPassthroughBehaviorOutput
}

MethodIntegrationPassthroughBehaviorInput is an input type that accepts values of the MethodIntegrationPassthroughBehavior enum A concrete instance of `MethodIntegrationPassthroughBehaviorInput` can be one of the following: 

MethodIntegrationPassthroughBehaviorWhenNoMatch
MethodIntegrationPassthroughBehaviorWhenNoTemplates
MethodIntegrationPassthroughBehaviorNever

type MethodIntegrationPassthroughBehaviorOutput added in v0.2.0 

type MethodIntegrationPassthroughBehaviorOutput struct{ *pulumi.OutputState }

func (MethodIntegrationPassthroughBehaviorOutput) ElementType added in v0.2.0 

func (MethodIntegrationPassthroughBehaviorOutput) ElementType() reflect.Type

func (MethodIntegrationPassthroughBehaviorOutput) ToMethodIntegrationPassthroughBehaviorOutput added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorOutput) ToMethodIntegrationPassthroughBehaviorOutput() MethodIntegrationPassthroughBehaviorOutput

func (MethodIntegrationPassthroughBehaviorOutput) ToMethodIntegrationPassthroughBehaviorOutputWithContext added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorOutput) ToMethodIntegrationPassthroughBehaviorOutputWithContext(ctx context.Context) MethodIntegrationPassthroughBehaviorOutput

func (MethodIntegrationPassthroughBehaviorOutput) ToMethodIntegrationPassthroughBehaviorPtrOutput added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorOutput) ToMethodIntegrationPassthroughBehaviorPtrOutput() MethodIntegrationPassthroughBehaviorPtrOutput

func (MethodIntegrationPassthroughBehaviorOutput) ToMethodIntegrationPassthroughBehaviorPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorOutput) ToMethodIntegrationPassthroughBehaviorPtrOutputWithContext(ctx context.Context) MethodIntegrationPassthroughBehaviorPtrOutput

func (MethodIntegrationPassthroughBehaviorOutput) ToStringOutput added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorOutput) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationPassthroughBehaviorOutput) ToStringOutputWithContext added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationPassthroughBehaviorOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationPassthroughBehaviorOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationPassthroughBehaviorPtrInput added in v0.2.0 

type MethodIntegrationPassthroughBehaviorPtrInput interface {
	pulumi.Input

	ToMethodIntegrationPassthroughBehaviorPtrOutput() MethodIntegrationPassthroughBehaviorPtrOutput
	ToMethodIntegrationPassthroughBehaviorPtrOutputWithContext(context.Context) MethodIntegrationPassthroughBehaviorPtrOutput
}

func MethodIntegrationPassthroughBehaviorPtr added in v0.2.0 

func MethodIntegrationPassthroughBehaviorPtr(v string) MethodIntegrationPassthroughBehaviorPtrInput

type MethodIntegrationPassthroughBehaviorPtrOutput added in v0.2.0 

type MethodIntegrationPassthroughBehaviorPtrOutput struct{ *pulumi.OutputState }

func (MethodIntegrationPassthroughBehaviorPtrOutput) Elem added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorPtrOutput) Elem() MethodIntegrationPassthroughBehaviorOutput

func (MethodIntegrationPassthroughBehaviorPtrOutput) ElementType added in v0.2.0 

func (MethodIntegrationPassthroughBehaviorPtrOutput) ElementType() reflect.Type

func (MethodIntegrationPassthroughBehaviorPtrOutput) ToMethodIntegrationPassthroughBehaviorPtrOutput added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorPtrOutput) ToMethodIntegrationPassthroughBehaviorPtrOutput() MethodIntegrationPassthroughBehaviorPtrOutput

func (MethodIntegrationPassthroughBehaviorPtrOutput) ToMethodIntegrationPassthroughBehaviorPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorPtrOutput) ToMethodIntegrationPassthroughBehaviorPtrOutputWithContext(ctx context.Context) MethodIntegrationPassthroughBehaviorPtrOutput

func (MethodIntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationPtrInput 

type MethodIntegrationPtrInput interface {
	pulumi.Input

	ToMethodIntegrationPtrOutput() MethodIntegrationPtrOutput
	ToMethodIntegrationPtrOutputWithContext(context.Context) MethodIntegrationPtrOutput
}

MethodIntegrationPtrInput is an input type that accepts MethodIntegrationArgs, MethodIntegrationPtr and MethodIntegrationPtrOutput values. You can construct a concrete instance of `MethodIntegrationPtrInput` via: 

        MethodIntegrationArgs{...}

or:

        nil

func MethodIntegrationPtr 

func MethodIntegrationPtr(v *MethodIntegrationArgs) MethodIntegrationPtrInput

type MethodIntegrationPtrOutput 

type MethodIntegrationPtrOutput struct{ *pulumi.OutputState }

func (MethodIntegrationPtrOutput) CacheKeyParameters 

func (o MethodIntegrationPtrOutput) CacheKeyParameters() pulumi.StringArrayOutput

A list of request parameters whose values API Gateway caches. To be valid values for “cacheKeyParameters“, these parameters must also be specified for Method “requestParameters“.

func (MethodIntegrationPtrOutput) CacheNamespace 

func (o MethodIntegrationPtrOutput) CacheNamespace() pulumi.StringPtrOutput

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the “cacheNamespace“. You can specify the same “cacheNamespace“ across resources to return the same cached data for requests to different resources.

func (MethodIntegrationPtrOutput) ConnectionId 

func (o MethodIntegrationPtrOutput) ConnectionId() pulumi.StringPtrOutput

The ID of the VpcLink used for the integration when “connectionType=VPC_LINK“ and undefined, otherwise.

func (MethodIntegrationPtrOutput) ConnectionType 

func (o MethodIntegrationPtrOutput) ConnectionType() MethodIntegrationConnectionTypePtrOutput

The type of the network connection to the integration endpoint. The valid value is “INTERNET“ for connections through the public routable internet or “VPC_LINK“ for private connections between API Gateway and a network load balancer in a VPC. The default value is “INTERNET“.

func (MethodIntegrationPtrOutput) ContentHandling 

func (o MethodIntegrationPtrOutput) ContentHandling() MethodIntegrationContentHandlingPtrOutput

Specifies how to handle request payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors: 

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 ``passthroughBehavior`` is configured to support payload pass-through.

func (MethodIntegrationPtrOutput) Credentials 

func (o MethodIntegrationPtrOutput) Credentials() pulumi.StringPtrOutput

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string “arn:aws:iam::\*:user/\*“. To use resource-based permissions on supported AWS services, specify null.

func (MethodIntegrationPtrOutput) Elem 

func (o MethodIntegrationPtrOutput) Elem() MethodIntegrationOutput

func (MethodIntegrationPtrOutput) ElementType 

func (MethodIntegrationPtrOutput) ElementType() reflect.Type

func (MethodIntegrationPtrOutput) IntegrationHttpMethod 

func (o MethodIntegrationPtrOutput) IntegrationHttpMethod() pulumi.StringPtrOutput

Specifies the integration's HTTP method type. For the Type property, if you specify “MOCK“, this property is optional. For Lambda integrations, you must set the integration method to “POST“. For all other types, you must specify this property.

func (MethodIntegrationPtrOutput) IntegrationResponses 

func (o MethodIntegrationPtrOutput) IntegrationResponses() MethodIntegrationResponseArrayOutput

Specifies the integration's responses.

func (MethodIntegrationPtrOutput) PassthroughBehavior 

func (o MethodIntegrationPtrOutput) PassthroughBehavior() MethodIntegrationPassthroughBehaviorPtrOutput

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in “requestTemplates“. The valid value is one of the following: “WHEN_NO_MATCH“: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. “WHEN_NO_TEMPLATES“: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. “NEVER“: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

func (MethodIntegrationPtrOutput) RequestParameters 

func (o MethodIntegrationPtrOutput) RequestParameters() pulumi.StringMapOutput

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of “method.request.{location}.{name}“, where “location“ is “querystring“, “path“, or “header“ and “name“ must be a valid and unique method request parameter name.

func (MethodIntegrationPtrOutput) RequestTemplates 

func (o MethodIntegrationPtrOutput) RequestTemplates() pulumi.StringMapOutput

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

func (MethodIntegrationPtrOutput) TimeoutInMillis 

func (o MethodIntegrationPtrOutput) TimeoutInMillis() pulumi.IntPtrOutput

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

func (MethodIntegrationPtrOutput) ToMethodIntegrationPtrOutput 

func (o MethodIntegrationPtrOutput) ToMethodIntegrationPtrOutput() MethodIntegrationPtrOutput

func (MethodIntegrationPtrOutput) ToMethodIntegrationPtrOutputWithContext 

func (o MethodIntegrationPtrOutput) ToMethodIntegrationPtrOutputWithContext(ctx context.Context) MethodIntegrationPtrOutput

func (MethodIntegrationPtrOutput) Type 

func (o MethodIntegrationPtrOutput) Type() MethodIntegrationTypePtrOutput

Specifies an API method integration type. The valid value is one of the following: 

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (``http/https``), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.

func (MethodIntegrationPtrOutput) Uri 

func (o MethodIntegrationPtrOutput) Uri() pulumi.StringPtrOutput

Specifies Uniform Resource Identifier (URI) of the integration endpoint. 

For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}``

type MethodIntegrationResponse 

type MethodIntegrationResponse struct {
	// Specifies how to handle response payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors:
	//  If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
	ContentHandling *MethodIntegrationResponseContentHandling `pulumi:"contentHandling"`
	// A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of “method.response.header.{name}“, where “name“ is a valid and unique header name. The mapped non-static value must match the pattern of “integration.response.header.{name}“ or “integration.response.body.{JSON-expression}“, where “name“ is a valid and unique response header name and “JSON-expression“ is a valid JSON expression without the “$“ prefix.
	ResponseParameters map[string]string `pulumi:"responseParameters"`
	// Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
	ResponseTemplates map[string]string `pulumi:"responseTemplates"`
	// Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the “.+“ regex to match error response. However, make sure that the error response does not contain any newline (“\n“) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
	SelectionPattern *string `pulumi:"selectionPattern"`
	// Specifies the status code that is used to map the integration response to an existing MethodResponse.
	StatusCode string `pulumi:"statusCode"`
}

“IntegrationResponse“ is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.

type MethodIntegrationResponseArgs 

type MethodIntegrationResponseArgs struct {
	// Specifies how to handle response payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors:
	//  If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
	ContentHandling MethodIntegrationResponseContentHandlingPtrInput `pulumi:"contentHandling"`
	// A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of “method.response.header.{name}“, where “name“ is a valid and unique header name. The mapped non-static value must match the pattern of “integration.response.header.{name}“ or “integration.response.body.{JSON-expression}“, where “name“ is a valid and unique response header name and “JSON-expression“ is a valid JSON expression without the “$“ prefix.
	ResponseParameters pulumi.StringMapInput `pulumi:"responseParameters"`
	// Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
	ResponseTemplates pulumi.StringMapInput `pulumi:"responseTemplates"`
	// Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the “.+“ regex to match error response. However, make sure that the error response does not contain any newline (“\n“) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
	SelectionPattern pulumi.StringPtrInput `pulumi:"selectionPattern"`
	// Specifies the status code that is used to map the integration response to an existing MethodResponse.
	StatusCode pulumi.StringInput `pulumi:"statusCode"`
}

“IntegrationResponse“ is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.

func (MethodIntegrationResponseArgs) ElementType 

func (MethodIntegrationResponseArgs) ElementType() reflect.Type

func (MethodIntegrationResponseArgs) ToMethodIntegrationResponseOutput 

func (i MethodIntegrationResponseArgs) ToMethodIntegrationResponseOutput() MethodIntegrationResponseOutput

func (MethodIntegrationResponseArgs) ToMethodIntegrationResponseOutputWithContext 

func (i MethodIntegrationResponseArgs) ToMethodIntegrationResponseOutputWithContext(ctx context.Context) MethodIntegrationResponseOutput

type MethodIntegrationResponseArray 

type MethodIntegrationResponseArray []MethodIntegrationResponseInput

func (MethodIntegrationResponseArray) ElementType 

func (MethodIntegrationResponseArray) ElementType() reflect.Type

func (MethodIntegrationResponseArray) ToMethodIntegrationResponseArrayOutput 

func (i MethodIntegrationResponseArray) ToMethodIntegrationResponseArrayOutput() MethodIntegrationResponseArrayOutput

func (MethodIntegrationResponseArray) ToMethodIntegrationResponseArrayOutputWithContext 

func (i MethodIntegrationResponseArray) ToMethodIntegrationResponseArrayOutputWithContext(ctx context.Context) MethodIntegrationResponseArrayOutput

type MethodIntegrationResponseArrayInput 

type MethodIntegrationResponseArrayInput interface {
	pulumi.Input

	ToMethodIntegrationResponseArrayOutput() MethodIntegrationResponseArrayOutput
	ToMethodIntegrationResponseArrayOutputWithContext(context.Context) MethodIntegrationResponseArrayOutput
}

MethodIntegrationResponseArrayInput is an input type that accepts MethodIntegrationResponseArray and MethodIntegrationResponseArrayOutput values. You can construct a concrete instance of `MethodIntegrationResponseArrayInput` via: 

MethodIntegrationResponseArray{ MethodIntegrationResponseArgs{...} }

type MethodIntegrationResponseArrayOutput 

type MethodIntegrationResponseArrayOutput struct{ *pulumi.OutputState }

func (MethodIntegrationResponseArrayOutput) ElementType 

func (MethodIntegrationResponseArrayOutput) ElementType() reflect.Type

func (MethodIntegrationResponseArrayOutput) Index 

func (o MethodIntegrationResponseArrayOutput) Index(i pulumi.IntInput) MethodIntegrationResponseOutput

func (MethodIntegrationResponseArrayOutput) ToMethodIntegrationResponseArrayOutput 

func (o MethodIntegrationResponseArrayOutput) ToMethodIntegrationResponseArrayOutput() MethodIntegrationResponseArrayOutput

func (MethodIntegrationResponseArrayOutput) ToMethodIntegrationResponseArrayOutputWithContext 

func (o MethodIntegrationResponseArrayOutput) ToMethodIntegrationResponseArrayOutputWithContext(ctx context.Context) MethodIntegrationResponseArrayOutput

type MethodIntegrationResponseContentHandling added in v0.2.0 

type MethodIntegrationResponseContentHandling string

Specifies how to handle response payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors: 

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

func (MethodIntegrationResponseContentHandling) ElementType added in v0.2.0 

func (MethodIntegrationResponseContentHandling) ElementType() reflect.Type

func (MethodIntegrationResponseContentHandling) ToMethodIntegrationResponseContentHandlingOutput added in v0.2.0 

func (e MethodIntegrationResponseContentHandling) ToMethodIntegrationResponseContentHandlingOutput() MethodIntegrationResponseContentHandlingOutput

func (MethodIntegrationResponseContentHandling) ToMethodIntegrationResponseContentHandlingOutputWithContext added in v0.2.0 

func (e MethodIntegrationResponseContentHandling) ToMethodIntegrationResponseContentHandlingOutputWithContext(ctx context.Context) MethodIntegrationResponseContentHandlingOutput

func (MethodIntegrationResponseContentHandling) ToMethodIntegrationResponseContentHandlingPtrOutput added in v0.2.0 

func (e MethodIntegrationResponseContentHandling) ToMethodIntegrationResponseContentHandlingPtrOutput() MethodIntegrationResponseContentHandlingPtrOutput

func (MethodIntegrationResponseContentHandling) ToMethodIntegrationResponseContentHandlingPtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationResponseContentHandling) ToMethodIntegrationResponseContentHandlingPtrOutputWithContext(ctx context.Context) MethodIntegrationResponseContentHandlingPtrOutput

func (MethodIntegrationResponseContentHandling) ToStringOutput added in v0.2.0 

func (e MethodIntegrationResponseContentHandling) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationResponseContentHandling) ToStringOutputWithContext added in v0.2.0 

func (e MethodIntegrationResponseContentHandling) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationResponseContentHandling) ToStringPtrOutput added in v0.2.0 

func (e MethodIntegrationResponseContentHandling) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationResponseContentHandling) ToStringPtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationResponseContentHandling) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationResponseContentHandlingInput added in v0.2.0 

type MethodIntegrationResponseContentHandlingInput interface {
	pulumi.Input

	ToMethodIntegrationResponseContentHandlingOutput() MethodIntegrationResponseContentHandlingOutput
	ToMethodIntegrationResponseContentHandlingOutputWithContext(context.Context) MethodIntegrationResponseContentHandlingOutput
}

MethodIntegrationResponseContentHandlingInput is an input type that accepts values of the MethodIntegrationResponseContentHandling enum A concrete instance of `MethodIntegrationResponseContentHandlingInput` can be one of the following: 

MethodIntegrationResponseContentHandlingConvertToBinary
MethodIntegrationResponseContentHandlingConvertToText

type MethodIntegrationResponseContentHandlingOutput added in v0.2.0 

type MethodIntegrationResponseContentHandlingOutput struct{ *pulumi.OutputState }

func (MethodIntegrationResponseContentHandlingOutput) ElementType added in v0.2.0 

func (MethodIntegrationResponseContentHandlingOutput) ElementType() reflect.Type

func (MethodIntegrationResponseContentHandlingOutput) ToMethodIntegrationResponseContentHandlingOutput added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingOutput) ToMethodIntegrationResponseContentHandlingOutput() MethodIntegrationResponseContentHandlingOutput

func (MethodIntegrationResponseContentHandlingOutput) ToMethodIntegrationResponseContentHandlingOutputWithContext added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingOutput) ToMethodIntegrationResponseContentHandlingOutputWithContext(ctx context.Context) MethodIntegrationResponseContentHandlingOutput

func (MethodIntegrationResponseContentHandlingOutput) ToMethodIntegrationResponseContentHandlingPtrOutput added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingOutput) ToMethodIntegrationResponseContentHandlingPtrOutput() MethodIntegrationResponseContentHandlingPtrOutput

func (MethodIntegrationResponseContentHandlingOutput) ToMethodIntegrationResponseContentHandlingPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingOutput) ToMethodIntegrationResponseContentHandlingPtrOutputWithContext(ctx context.Context) MethodIntegrationResponseContentHandlingPtrOutput

func (MethodIntegrationResponseContentHandlingOutput) ToStringOutput added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingOutput) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationResponseContentHandlingOutput) ToStringOutputWithContext added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationResponseContentHandlingOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationResponseContentHandlingOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationResponseContentHandlingPtrInput added in v0.2.0 

type MethodIntegrationResponseContentHandlingPtrInput interface {
	pulumi.Input

	ToMethodIntegrationResponseContentHandlingPtrOutput() MethodIntegrationResponseContentHandlingPtrOutput
	ToMethodIntegrationResponseContentHandlingPtrOutputWithContext(context.Context) MethodIntegrationResponseContentHandlingPtrOutput
}

func MethodIntegrationResponseContentHandlingPtr added in v0.2.0 

func MethodIntegrationResponseContentHandlingPtr(v string) MethodIntegrationResponseContentHandlingPtrInput

type MethodIntegrationResponseContentHandlingPtrOutput added in v0.2.0 

type MethodIntegrationResponseContentHandlingPtrOutput struct{ *pulumi.OutputState }

func (MethodIntegrationResponseContentHandlingPtrOutput) Elem added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingPtrOutput) Elem() MethodIntegrationResponseContentHandlingOutput

func (MethodIntegrationResponseContentHandlingPtrOutput) ElementType added in v0.2.0 

func (MethodIntegrationResponseContentHandlingPtrOutput) ElementType() reflect.Type

func (MethodIntegrationResponseContentHandlingPtrOutput) ToMethodIntegrationResponseContentHandlingPtrOutput added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingPtrOutput) ToMethodIntegrationResponseContentHandlingPtrOutput() MethodIntegrationResponseContentHandlingPtrOutput

func (MethodIntegrationResponseContentHandlingPtrOutput) ToMethodIntegrationResponseContentHandlingPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingPtrOutput) ToMethodIntegrationResponseContentHandlingPtrOutputWithContext(ctx context.Context) MethodIntegrationResponseContentHandlingPtrOutput

func (MethodIntegrationResponseContentHandlingPtrOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationResponseContentHandlingPtrOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationResponseContentHandlingPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationResponseInput 

type MethodIntegrationResponseInput interface {
	pulumi.Input

	ToMethodIntegrationResponseOutput() MethodIntegrationResponseOutput
	ToMethodIntegrationResponseOutputWithContext(context.Context) MethodIntegrationResponseOutput
}

MethodIntegrationResponseInput is an input type that accepts MethodIntegrationResponseArgs and MethodIntegrationResponseOutput values. You can construct a concrete instance of `MethodIntegrationResponseInput` via: 

MethodIntegrationResponseArgs{...}

type MethodIntegrationResponseOutput 

type MethodIntegrationResponseOutput struct{ *pulumi.OutputState }

“IntegrationResponse“ is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.

func (MethodIntegrationResponseOutput) ContentHandling 

func (o MethodIntegrationResponseOutput) ContentHandling() MethodIntegrationResponseContentHandlingPtrOutput

Specifies how to handle response payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors: 

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

func (MethodIntegrationResponseOutput) ElementType 

func (MethodIntegrationResponseOutput) ElementType() reflect.Type

func (MethodIntegrationResponseOutput) ResponseParameters 

func (o MethodIntegrationResponseOutput) ResponseParameters() pulumi.StringMapOutput

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of “method.response.header.{name}“, where “name“ is a valid and unique header name. The mapped non-static value must match the pattern of “integration.response.header.{name}“ or “integration.response.body.{JSON-expression}“, where “name“ is a valid and unique response header name and “JSON-expression“ is a valid JSON expression without the “$“ prefix.

func (MethodIntegrationResponseOutput) ResponseTemplates 

func (o MethodIntegrationResponseOutput) ResponseTemplates() pulumi.StringMapOutput

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

func (MethodIntegrationResponseOutput) SelectionPattern 

func (o MethodIntegrationResponseOutput) SelectionPattern() pulumi.StringPtrOutput

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the “.+“ regex to match error response. However, make sure that the error response does not contain any newline (“\n“) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

func (MethodIntegrationResponseOutput) StatusCode 

func (o MethodIntegrationResponseOutput) StatusCode() pulumi.StringOutput

Specifies the status code that is used to map the integration response to an existing MethodResponse.

func (MethodIntegrationResponseOutput) ToMethodIntegrationResponseOutput 

func (o MethodIntegrationResponseOutput) ToMethodIntegrationResponseOutput() MethodIntegrationResponseOutput

func (MethodIntegrationResponseOutput) ToMethodIntegrationResponseOutputWithContext 

func (o MethodIntegrationResponseOutput) ToMethodIntegrationResponseOutputWithContext(ctx context.Context) MethodIntegrationResponseOutput

type MethodIntegrationType added in v0.2.0 

type MethodIntegrationType string

Specifies an API method integration type. The valid value is one of the following: 

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (``http/https``), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.

func (MethodIntegrationType) ElementType added in v0.2.0 

func (MethodIntegrationType) ElementType() reflect.Type

func (MethodIntegrationType) ToMethodIntegrationTypeOutput added in v0.2.0 

func (e MethodIntegrationType) ToMethodIntegrationTypeOutput() MethodIntegrationTypeOutput

func (MethodIntegrationType) ToMethodIntegrationTypeOutputWithContext added in v0.2.0 

func (e MethodIntegrationType) ToMethodIntegrationTypeOutputWithContext(ctx context.Context) MethodIntegrationTypeOutput

func (MethodIntegrationType) ToMethodIntegrationTypePtrOutput added in v0.2.0 

func (e MethodIntegrationType) ToMethodIntegrationTypePtrOutput() MethodIntegrationTypePtrOutput

func (MethodIntegrationType) ToMethodIntegrationTypePtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationType) ToMethodIntegrationTypePtrOutputWithContext(ctx context.Context) MethodIntegrationTypePtrOutput

func (MethodIntegrationType) ToStringOutput added in v0.2.0 

func (e MethodIntegrationType) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationType) ToStringOutputWithContext added in v0.2.0 

func (e MethodIntegrationType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationType) ToStringPtrOutput added in v0.2.0 

func (e MethodIntegrationType) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationType) ToStringPtrOutputWithContext added in v0.2.0 

func (e MethodIntegrationType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationTypeInput added in v0.2.0 

type MethodIntegrationTypeInput interface {
	pulumi.Input

	ToMethodIntegrationTypeOutput() MethodIntegrationTypeOutput
	ToMethodIntegrationTypeOutputWithContext(context.Context) MethodIntegrationTypeOutput
}

MethodIntegrationTypeInput is an input type that accepts values of the MethodIntegrationType enum A concrete instance of `MethodIntegrationTypeInput` can be one of the following: 

MethodIntegrationTypeAws
MethodIntegrationTypeAwsProxy
MethodIntegrationTypeHttp
MethodIntegrationTypeHttpProxy
MethodIntegrationTypeMock

type MethodIntegrationTypeOutput added in v0.2.0 

type MethodIntegrationTypeOutput struct{ *pulumi.OutputState }

func (MethodIntegrationTypeOutput) ElementType added in v0.2.0 

func (MethodIntegrationTypeOutput) ElementType() reflect.Type

func (MethodIntegrationTypeOutput) ToMethodIntegrationTypeOutput added in v0.2.0 

func (o MethodIntegrationTypeOutput) ToMethodIntegrationTypeOutput() MethodIntegrationTypeOutput

func (MethodIntegrationTypeOutput) ToMethodIntegrationTypeOutputWithContext added in v0.2.0 

func (o MethodIntegrationTypeOutput) ToMethodIntegrationTypeOutputWithContext(ctx context.Context) MethodIntegrationTypeOutput

func (MethodIntegrationTypeOutput) ToMethodIntegrationTypePtrOutput added in v0.2.0 

func (o MethodIntegrationTypeOutput) ToMethodIntegrationTypePtrOutput() MethodIntegrationTypePtrOutput

func (MethodIntegrationTypeOutput) ToMethodIntegrationTypePtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationTypeOutput) ToMethodIntegrationTypePtrOutputWithContext(ctx context.Context) MethodIntegrationTypePtrOutput

func (MethodIntegrationTypeOutput) ToStringOutput added in v0.2.0 

func (o MethodIntegrationTypeOutput) ToStringOutput() pulumi.StringOutput

func (MethodIntegrationTypeOutput) ToStringOutputWithContext added in v0.2.0 

func (o MethodIntegrationTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodIntegrationTypeOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationTypeOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodIntegrationTypePtrInput added in v0.2.0 

type MethodIntegrationTypePtrInput interface {
	pulumi.Input

	ToMethodIntegrationTypePtrOutput() MethodIntegrationTypePtrOutput
	ToMethodIntegrationTypePtrOutputWithContext(context.Context) MethodIntegrationTypePtrOutput
}

func MethodIntegrationTypePtr added in v0.2.0 

func MethodIntegrationTypePtr(v string) MethodIntegrationTypePtrInput

type MethodIntegrationTypePtrOutput added in v0.2.0 

type MethodIntegrationTypePtrOutput struct{ *pulumi.OutputState }

func (MethodIntegrationTypePtrOutput) Elem added in v0.2.0 

func (o MethodIntegrationTypePtrOutput) Elem() MethodIntegrationTypeOutput

func (MethodIntegrationTypePtrOutput) ElementType added in v0.2.0 

func (MethodIntegrationTypePtrOutput) ElementType() reflect.Type

func (MethodIntegrationTypePtrOutput) ToMethodIntegrationTypePtrOutput added in v0.2.0 

func (o MethodIntegrationTypePtrOutput) ToMethodIntegrationTypePtrOutput() MethodIntegrationTypePtrOutput

func (MethodIntegrationTypePtrOutput) ToMethodIntegrationTypePtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationTypePtrOutput) ToMethodIntegrationTypePtrOutputWithContext(ctx context.Context) MethodIntegrationTypePtrOutput

func (MethodIntegrationTypePtrOutput) ToStringPtrOutput added in v0.2.0 

func (o MethodIntegrationTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodIntegrationTypePtrOutput) ToStringPtrOutputWithContext added in v0.2.0 

func (o MethodIntegrationTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodOutput 

type MethodOutput struct{ *pulumi.OutputState }

func (MethodOutput) ApiKeyRequired added in v0.17.0 

func (o MethodOutput) ApiKeyRequired() pulumi.BoolPtrOutput

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

func (MethodOutput) AuthorizationScopes added in v0.17.0 

func (o MethodOutput) AuthorizationScopes() pulumi.StringArrayOutput

A list of authorization scopes configured on the method. The scopes are used with a “COGNITO_USER_POOLS“ authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

func (MethodOutput) AuthorizationType added in v0.17.0 

func (o MethodOutput) AuthorizationType() MethodAuthorizationTypePtrOutput

The method's authorization type. This parameter is required. For valid values, see Method(https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. 

If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.

func (MethodOutput) AuthorizerId added in v0.17.0 

func (o MethodOutput) AuthorizerId() pulumi.StringPtrOutput

The identifier of an authorizer to use on this method. The method's authorization type must be “CUSTOM“ or “COGNITO_USER_POOLS“.

func (MethodOutput) ElementType 

func (MethodOutput) ElementType() reflect.Type

func (MethodOutput) HttpMethod added in v0.17.0 

func (o MethodOutput) HttpMethod() pulumi.StringOutput

The method's HTTP verb.

func (MethodOutput) Integration added in v0.17.0 

func (o MethodOutput) Integration() MethodIntegrationPtrOutput

Represents an “HTTP“, “HTTP_PROXY“, “AWS“, “AWS_PROXY“, or Mock integration.

func (MethodOutput) MethodResponses added in v0.17.0 

func (o MethodOutput) MethodResponses() MethodResponseArrayOutput

Gets a method response associated with a given HTTP status code.

func (MethodOutput) OperationName added in v0.17.0 

func (o MethodOutput) OperationName() pulumi.StringPtrOutput

A human-friendly operation identifier for the method. For example, you can assign the “operationName“ of “ListPets“ for the “GET /pets“ method in the “PetStore“ example.

func (MethodOutput) RequestModels added in v0.17.0 

func (o MethodOutput) RequestModels() pulumi.StringMapOutput

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

func (MethodOutput) RequestParameters added in v0.17.0 

func (o MethodOutput) RequestParameters() pulumi.MapOutput

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of “method.request.{location}.{name}“, where “location“ is “querystring“, “path“, or “header“ and “name“ is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (“true“) or optional (“false“). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

func (MethodOutput) RequestValidatorId added in v0.17.0 

func (o MethodOutput) RequestValidatorId() pulumi.StringPtrOutput

The identifier of a RequestValidator for request validation.

func (MethodOutput) ResourceId added in v0.17.0 

func (o MethodOutput) ResourceId() pulumi.StringOutput

The Resource identifier for the MethodResponse resource.

func (MethodOutput) RestApiId added in v0.17.0 

func (o MethodOutput) RestApiId() pulumi.StringOutput

The string identifier of the associated RestApi.

func (MethodOutput) ToMethodOutput 

func (o MethodOutput) ToMethodOutput() MethodOutput

func (MethodOutput) ToMethodOutputWithContext 

func (o MethodOutput) ToMethodOutputWithContext(ctx context.Context) MethodOutput

type MethodResponse added in v0.2.0 

type MethodResponse struct {
	// Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
	ResponseModels map[string]string `pulumi:"responseModels"`
	// A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern “method.response.header.{name}“, where “name“ is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in “integration.response.header.{name}“, a static value enclosed within a pair of single quotes (e.g., “'application/json'“), or a JSON expression from the back-end response payload in the form of “integration.response.body.{JSON-expression}“, where “JSON-expression“ is a valid JSON expression without the “$“ prefix.)
	ResponseParameters map[string]interface{} `pulumi:"responseParameters"`
	// The method response's status code.
	StatusCode string `pulumi:"statusCode"`
}

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

type MethodResponseArgs added in v0.2.0 

type MethodResponseArgs struct {
	// Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
	ResponseModels pulumi.StringMapInput `pulumi:"responseModels"`
	// A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern “method.response.header.{name}“, where “name“ is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in “integration.response.header.{name}“, a static value enclosed within a pair of single quotes (e.g., “'application/json'“), or a JSON expression from the back-end response payload in the form of “integration.response.body.{JSON-expression}“, where “JSON-expression“ is a valid JSON expression without the “$“ prefix.)
	ResponseParameters pulumi.MapInput `pulumi:"responseParameters"`
	// The method response's status code.
	StatusCode pulumi.StringInput `pulumi:"statusCode"`
}

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

func (MethodResponseArgs) ElementType added in v0.2.0 

func (MethodResponseArgs) ElementType() reflect.Type

func (MethodResponseArgs) ToMethodResponseOutput added in v0.2.0 

func (i MethodResponseArgs) ToMethodResponseOutput() MethodResponseOutput

func (MethodResponseArgs) ToMethodResponseOutputWithContext added in v0.2.0 

func (i MethodResponseArgs) ToMethodResponseOutputWithContext(ctx context.Context) MethodResponseOutput

type MethodResponseArray added in v0.2.0 

type MethodResponseArray []MethodResponseInput

func (MethodResponseArray) ElementType added in v0.2.0 

func (MethodResponseArray) ElementType() reflect.Type

func (MethodResponseArray) ToMethodResponseArrayOutput added in v0.2.0 

func (i MethodResponseArray) ToMethodResponseArrayOutput() MethodResponseArrayOutput

func (MethodResponseArray) ToMethodResponseArrayOutputWithContext added in v0.2.0 

func (i MethodResponseArray) ToMethodResponseArrayOutputWithContext(ctx context.Context) MethodResponseArrayOutput

type MethodResponseArrayInput added in v0.2.0 

type MethodResponseArrayInput interface {
	pulumi.Input

	ToMethodResponseArrayOutput() MethodResponseArrayOutput
	ToMethodResponseArrayOutputWithContext(context.Context) MethodResponseArrayOutput
}

MethodResponseArrayInput is an input type that accepts MethodResponseArray and MethodResponseArrayOutput values. You can construct a concrete instance of `MethodResponseArrayInput` via: 

MethodResponseArray{ MethodResponseArgs{...} }

type MethodResponseArrayOutput added in v0.2.0 

type MethodResponseArrayOutput struct{ *pulumi.OutputState }

func (MethodResponseArrayOutput) ElementType added in v0.2.0 

func (MethodResponseArrayOutput) ElementType() reflect.Type

func (MethodResponseArrayOutput) Index added in v0.2.0 

func (o MethodResponseArrayOutput) Index(i pulumi.IntInput) MethodResponseOutput

func (MethodResponseArrayOutput) ToMethodResponseArrayOutput added in v0.2.0 

func (o MethodResponseArrayOutput) ToMethodResponseArrayOutput() MethodResponseArrayOutput

func (MethodResponseArrayOutput) ToMethodResponseArrayOutputWithContext added in v0.2.0 

func (o MethodResponseArrayOutput) ToMethodResponseArrayOutputWithContext(ctx context.Context) MethodResponseArrayOutput

type MethodResponseInput added in v0.2.0 

type MethodResponseInput interface {
	pulumi.Input

	ToMethodResponseOutput() MethodResponseOutput
	ToMethodResponseOutputWithContext(context.Context) MethodResponseOutput
}

MethodResponseInput is an input type that accepts MethodResponseArgs and MethodResponseOutput values. You can construct a concrete instance of `MethodResponseInput` via: 

MethodResponseArgs{...}

type MethodResponseOutput added in v0.2.0 

type MethodResponseOutput struct{ *pulumi.OutputState }

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

func (MethodResponseOutput) ElementType added in v0.2.0 

func (MethodResponseOutput) ElementType() reflect.Type

func (MethodResponseOutput) ResponseModels added in v0.2.0 

func (o MethodResponseOutput) ResponseModels() pulumi.StringMapOutput

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

func (MethodResponseOutput) ResponseParameters added in v0.2.0 

func (o MethodResponseOutput) ResponseParameters() pulumi.MapOutput

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern “method.response.header.{name}“, where “name“ is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in “integration.response.header.{name}“, a static value enclosed within a pair of single quotes (e.g., “'application/json'“), or a JSON expression from the back-end response payload in the form of “integration.response.body.{JSON-expression}“, where “JSON-expression“ is a valid JSON expression without the “$“ prefix.)

func (MethodResponseOutput) StatusCode added in v0.2.0 

func (o MethodResponseOutput) StatusCode() pulumi.StringOutput

The method response's status code.

func (MethodResponseOutput) ToMethodResponseOutput added in v0.2.0 

func (o MethodResponseOutput) ToMethodResponseOutput() MethodResponseOutput

func (MethodResponseOutput) ToMethodResponseOutputWithContext added in v0.2.0 

func (o MethodResponseOutput) ToMethodResponseOutputWithContext(ctx context.Context) MethodResponseOutput

type MethodState 

type MethodState struct {
}

func (MethodState) ElementType 

func (MethodState) ElementType() reflect.Type

type Model 

type Model struct {
	pulumi.CustomResourceState

	// The content-type for the model.
	ContentType pulumi.StringPtrOutput `pulumi:"contentType"`
	// The description of the model.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
	//   If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// The schema for the model. For “application/json“ models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::Model` for more information about the expected schema for this property.
	Schema pulumi.AnyOutput `pulumi:"schema"`
}

The “AWS::ApiGateway::Model“ resource defines the structure of a request or response payload for an API method.

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.

func (*Model) ElementType 

func (*Model) ElementType() reflect.Type

func (*Model) ToModelOutput 

func (i *Model) ToModelOutput() ModelOutput

func (*Model) ToModelOutputWithContext 

func (i *Model) ToModelOutputWithContext(ctx context.Context) ModelOutput

type ModelArgs 

type ModelArgs struct {
	// The content-type for the model.
	ContentType pulumi.StringPtrInput
	// The description of the model.
	Description pulumi.StringPtrInput
	// A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
	//   If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	Name pulumi.StringPtrInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput
	// The schema for the model. For “application/json“ models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::Model` for more information about the expected schema for this property.
	Schema pulumi.Input
}

The set of arguments for constructing a Model resource.

func (ModelArgs) ElementType 

func (ModelArgs) ElementType() reflect.Type

type ModelInput 

type ModelInput interface {
	pulumi.Input

	ToModelOutput() ModelOutput
	ToModelOutputWithContext(ctx context.Context) ModelOutput
}

type ModelOutput 

type ModelOutput struct{ *pulumi.OutputState }

func (ModelOutput) ContentType added in v0.17.0 

func (o ModelOutput) ContentType() pulumi.StringPtrOutput

The content-type for the model.

func (ModelOutput) Description added in v0.17.0 

func (o ModelOutput) Description() pulumi.StringPtrOutput

The description of the model.

func (ModelOutput) ElementType 

func (ModelOutput) ElementType() reflect.Type

func (ModelOutput) Name added in v0.17.0 

func (o ModelOutput) Name() pulumi.StringPtrOutput

A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). 

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

func (ModelOutput) RestApiId added in v0.17.0 

func (o ModelOutput) RestApiId() pulumi.StringOutput

The string identifier of the associated RestApi.

func (ModelOutput) Schema added in v0.17.0 

func (o ModelOutput) Schema() pulumi.AnyOutput

The schema for the model. For “application/json“ models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::Model` for more information about the expected schema for this property.

func (ModelOutput) ToModelOutput 

func (o ModelOutput) ToModelOutput() ModelOutput

func (ModelOutput) ToModelOutputWithContext 

func (o ModelOutput) ToModelOutputWithContext(ctx context.Context) ModelOutput

type ModelState 

type ModelState struct {
}

func (ModelState) ElementType 

func (ModelState) ElementType() reflect.Type

type RequestValidator 

type RequestValidator struct {
	pulumi.CustomResourceState

	// The name of this RequestValidator
	Name               pulumi.StringPtrOutput `pulumi:"name"`
	RequestValidatorId pulumi.StringOutput    `pulumi:"requestValidatorId"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
	ValidateRequestBody pulumi.BoolPtrOutput `pulumi:"validateRequestBody"`
	// A Boolean flag to indicate whether to validate request parameters (“true“) or not (“false“).
	ValidateRequestParameters pulumi.BoolPtrOutput `pulumi:"validateRequestParameters"`
}

The “AWS::ApiGateway::RequestValidator“ resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.

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.

func (*RequestValidator) ElementType 

func (*RequestValidator) ElementType() reflect.Type

func (*RequestValidator) ToRequestValidatorOutput 

func (i *RequestValidator) ToRequestValidatorOutput() RequestValidatorOutput

func (*RequestValidator) ToRequestValidatorOutputWithContext 

func (i *RequestValidator) ToRequestValidatorOutputWithContext(ctx context.Context) RequestValidatorOutput

type RequestValidatorArgs 

type RequestValidatorArgs struct {
	// The name of this RequestValidator
	Name pulumi.StringPtrInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput
	// A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
	ValidateRequestBody pulumi.BoolPtrInput
	// A Boolean flag to indicate whether to validate request parameters (“true“) or not (“false“).
	ValidateRequestParameters pulumi.BoolPtrInput
}

The set of arguments for constructing a RequestValidator resource.

func (RequestValidatorArgs) ElementType 

func (RequestValidatorArgs) ElementType() reflect.Type

type RequestValidatorInput 

type RequestValidatorInput interface {
	pulumi.Input

	ToRequestValidatorOutput() RequestValidatorOutput
	ToRequestValidatorOutputWithContext(ctx context.Context) RequestValidatorOutput
}

type RequestValidatorOutput 

type RequestValidatorOutput struct{ *pulumi.OutputState }

func (RequestValidatorOutput) ElementType 

func (RequestValidatorOutput) ElementType() reflect.Type

func (RequestValidatorOutput) Name added in v0.17.0 

func (o RequestValidatorOutput) Name() pulumi.StringPtrOutput

The name of this RequestValidator

func (RequestValidatorOutput) RequestValidatorId added in v0.17.0 

func (o RequestValidatorOutput) RequestValidatorId() pulumi.StringOutput

func (RequestValidatorOutput) RestApiId added in v0.17.0 

func (o RequestValidatorOutput) RestApiId() pulumi.StringOutput

The string identifier of the associated RestApi.

func (RequestValidatorOutput) ToRequestValidatorOutput 

func (o RequestValidatorOutput) ToRequestValidatorOutput() RequestValidatorOutput

func (RequestValidatorOutput) ToRequestValidatorOutputWithContext 

func (o RequestValidatorOutput) ToRequestValidatorOutputWithContext(ctx context.Context) RequestValidatorOutput

func (RequestValidatorOutput) ValidateRequestBody added in v0.17.0 

func (o RequestValidatorOutput) ValidateRequestBody() pulumi.BoolPtrOutput

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

func (RequestValidatorOutput) ValidateRequestParameters added in v0.17.0 

func (o RequestValidatorOutput) ValidateRequestParameters() pulumi.BoolPtrOutput

A Boolean flag to indicate whether to validate request parameters (“true“) or not (“false“).

type RequestValidatorState 

type RequestValidatorState struct {
}

func (RequestValidatorState) ElementType 

func (RequestValidatorState) ElementType() reflect.Type

type Resource 

type Resource struct {
	pulumi.CustomResourceState

	// The parent resource's identifier.
	ParentId pulumi.StringOutput `pulumi:"parentId"`
	// The last path segment for this resource.
	PathPart   pulumi.StringOutput `pulumi:"pathPart"`
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
}

The “AWS::ApiGateway::Resource“ resource creates a resource in an API.

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.

func (*Resource) ElementType 

func (*Resource) ElementType() reflect.Type

func (*Resource) ToResourceOutput 

func (i *Resource) ToResourceOutput() ResourceOutput

func (*Resource) ToResourceOutputWithContext 

func (i *Resource) ToResourceOutputWithContext(ctx context.Context) ResourceOutput

type ResourceArgs 

type ResourceArgs struct {
	// The parent resource's identifier.
	ParentId pulumi.StringInput
	// The last path segment for this resource.
	PathPart pulumi.StringInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput
}

The set of arguments for constructing a Resource resource.

func (ResourceArgs) ElementType 

func (ResourceArgs) ElementType() reflect.Type

type ResourceInput 

type ResourceInput interface {
	pulumi.Input

	ToResourceOutput() ResourceOutput
	ToResourceOutputWithContext(ctx context.Context) ResourceOutput
}

type ResourceOutput 

type ResourceOutput struct{ *pulumi.OutputState }

func (ResourceOutput) ElementType 

func (ResourceOutput) ElementType() reflect.Type

func (ResourceOutput) ParentId added in v0.17.0 

func (o ResourceOutput) ParentId() pulumi.StringOutput

The parent resource's identifier.

func (ResourceOutput) PathPart added in v0.17.0 

func (o ResourceOutput) PathPart() pulumi.StringOutput

The last path segment for this resource.

func (ResourceOutput) ResourceId added in v0.17.0 

func (o ResourceOutput) ResourceId() pulumi.StringOutput

func (ResourceOutput) RestApiId added in v0.17.0 

func (o ResourceOutput) RestApiId() pulumi.StringOutput

The string identifier of the associated RestApi.

func (ResourceOutput) ToResourceOutput 

func (o ResourceOutput) ToResourceOutput() ResourceOutput

func (ResourceOutput) ToResourceOutputWithContext 

func (o ResourceOutput) ToResourceOutputWithContext(ctx context.Context) ResourceOutput

type ResourceState 

type ResourceState struct {
}

func (ResourceState) ElementType 

func (ResourceState) ElementType() reflect.Type

type RestApi 

type RestApi struct {
	pulumi.CustomResourceState

	// The source of the API key for metering requests according to a usage plan. Valid values are: “HEADER“ to read the API key from the “X-API-Key“ header of a request. “AUTHORIZER“ to read the API key from the “UsageIdentifierKey“ from a custom authorizer.
	ApiKeySourceType pulumi.StringPtrOutput `pulumi:"apiKeySourceType"`
	// 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 a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.
	Body pulumi.AnyOutput `pulumi:"body"`
	// The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
	BodyS3Location RestApiS3LocationPtrOutput `pulumi:"bodyS3Location"`
	// The ID of the RestApi that you want to clone from.
	CloneFrom pulumi.StringPtrOutput `pulumi:"cloneFrom"`
	// The description of the RestApi.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies whether clients can invoke your API by using the default “execute-api“ endpoint. By default, clients can invoke your API with the default “https://{api_id}.execute-api.{region}.amazonaws.com“ endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
	DisableExecuteApiEndpoint pulumi.BoolPtrOutput `pulumi:"disableExecuteApiEndpoint"`
	// A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the “Parameters“ property.
	EndpointConfiguration RestApiEndpointConfigurationPtrOutput `pulumi:"endpointConfiguration"`
	// A query parameter to indicate whether to rollback the API update (“true“) or not (“false“) when a warning is encountered. The default value is “false“.
	FailOnWarnings pulumi.BoolPtrOutput `pulumi:"failOnWarnings"`
	// A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
	MinimumCompressionSize pulumi.IntPtrOutput `pulumi:"minimumCompressionSize"`
	// This property applies only when you use OpenAPI to define your REST API. The “Mode“ determines how API Gateway handles resource updates.
	//  Valid values are “overwrite“ or “merge“.
	//  For “overwrite“, the new API definition replaces the existing one. The existing API identifier remains unchanged.
	//   For “merge“, the new API definition is merged with the existing API.
	//  If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is “overwrite“. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
	//  Use the default mode to define top-level “RestApi“ properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
	Mode pulumi.StringPtrOutput `pulumi:"mode"`
	// The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set “ignore=documentation“ as a “parameters“ value, as in the AWS CLI command of “aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'“.
	Parameters pulumi.StringMapOutput `pulumi:"parameters"`
	// A policy document that contains the permissions for the “RestApi“ resource. To set the ARN for the policy, use the “!Join“ intrinsic function with “""“ as delimiter and values of “"execute-api:/"“ and “"*"“.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.
	Policy         pulumi.AnyOutput    `pulumi:"policy"`
	RestApiId      pulumi.StringOutput `pulumi:"restApiId"`
	RootResourceId pulumi.StringOutput `pulumi:"rootResourceId"`
	// The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

The “AWS::ApiGateway::RestApi“ resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*. 

On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.

## Example Usage ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiName := cfg.Require("apiName")
		description := cfg.Require("description")
		version := cfg.Require("version")
		_type := cfg.Require("type")
		property := cfg.Require("property")
		restApi, err := apigateway.NewRestApi(ctx, "restApi", &apigateway.RestApiArgs{
			Name: pulumi.String(apiName),
		})
		if err != nil {
			return err
		}
		documentationPart, err := apigateway.NewDocumentationPart(ctx, "documentationPart", &apigateway.DocumentationPartArgs{
			Location: &apigateway.DocumentationPartLocationArgs{
				Type: apigateway.DocumentationPartLocationType(_type),
			},
			RestApiId:  restApi.ID(),
			Properties: pulumi.String(property),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewDocumentationVersion(ctx, "documentationVersion", &apigateway.DocumentationVersionArgs{
			Description:          pulumi.String(description),
			DocumentationVersion: pulumi.String(version),
			RestApiId:            restApi.ID(),
		}, pulumi.DependsOn([]pulumi.Resource{
			documentationPart,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiName := cfg.Require("apiName")
		description := cfg.Require("description")
		version := cfg.Require("version")
		_type := cfg.Require("type")
		property := cfg.Require("property")
		restApi, err := apigateway.NewRestApi(ctx, "restApi", &apigateway.RestApiArgs{
			Name: pulumi.String(apiName),
		})
		if err != nil {
			return err
		}
		documentationPart, err := apigateway.NewDocumentationPart(ctx, "documentationPart", &apigateway.DocumentationPartArgs{
			Location: &apigateway.DocumentationPartLocationArgs{
				Type: apigateway.DocumentationPartLocationType(_type),
			},
			RestApiId:  restApi.ID(),
			Properties: pulumi.String(property),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewDocumentationVersion(ctx, "documentationVersion", &apigateway.DocumentationVersionArgs{
			Description:          pulumi.String(description),
			DocumentationVersion: pulumi.String(version),
			RestApiId:            restApi.ID(),
		}, pulumi.DependsOn([]pulumi.Resource{
			documentationPart,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		contentHandling := cfg.Require("contentHandling")
		operationName := "testoperationName"
		if param := cfg.Get("operationName"); param != "" {
			operationName = param
		}
		restApiName := "testrestApiName"
		if param := cfg.Get("restApiName"); param != "" {
			restApiName = param
		}
		validatorName := "testvalidatorName"
		if param := cfg.Get("validatorName"); param != "" {
			validatorName = param
		}
		validateRequestBody := "testvalidateRequestBody"
		if param := cfg.Get("validateRequestBody"); param != "" {
			validateRequestBody = param
		}
		validateRequestParameters := true
		if param := cfg.Get("validateRequestParameters"); param != "" {
			validateRequestParameters = param
		}
		restApi, err := apigateway.NewRestApi(ctx, "restApi", &apigateway.RestApiArgs{
			Name: pulumi.String(restApiName),
		})
		if err != nil {
			return err
		}
		requestValidator, err := apigateway.NewRequestValidator(ctx, "requestValidator", &apigateway.RequestValidatorArgs{
			Name:                      pulumi.String(validatorName),
			RestApiId:                 restApi.ID(),
			ValidateRequestBody:       pulumi.String(validateRequestBody),
			ValidateRequestParameters: pulumi.String(validateRequestParameters),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewMethod(ctx, "method", &apigateway.MethodArgs{
			HttpMethod:        pulumi.String("POST"),
			ResourceId:        restApi.RootResourceId,
			RestApiId:         restApi.ID(),
			AuthorizationType: apigateway.MethodAuthorizationTypeNone,
			Integration: &apigateway.MethodIntegrationArgs{
				Type:            apigateway.MethodIntegrationTypeMock,
				ContentHandling: apigateway.MethodIntegrationContentHandling(contentHandling),
				IntegrationResponses: apigateway.MethodIntegrationResponseArray{
					&apigateway.MethodIntegrationResponseArgs{
						ContentHandling: apigateway.MethodIntegrationResponseContentHandling(contentHandling),
						StatusCode:      pulumi.String("400"),
					},
				},
			},
			RequestValidatorId: requestValidator.ID(),
			OperationName:      pulumi.String(operationName),
		})
		if err != nil {
			return err
		}
		ctx.Export("rootResourceId", restApi.RootResourceId)
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		contentHandling := cfg.Require("contentHandling")
		operationName := "testoperationName"
		if param := cfg.Get("operationName"); param != "" {
			operationName = param
		}
		restApiName := "testrestApiName"
		if param := cfg.Get("restApiName"); param != "" {
			restApiName = param
		}
		validatorName := "testvalidatorName"
		if param := cfg.Get("validatorName"); param != "" {
			validatorName = param
		}
		validateRequestBody := "testvalidateRequestBody"
		if param := cfg.Get("validateRequestBody"); param != "" {
			validateRequestBody = param
		}
		validateRequestParameters := true
		if param := cfg.Get("validateRequestParameters"); param != "" {
			validateRequestParameters = param
		}
		restApi, err := apigateway.NewRestApi(ctx, "restApi", &apigateway.RestApiArgs{
			Name: pulumi.String(restApiName),
		})
		if err != nil {
			return err
		}
		requestValidator, err := apigateway.NewRequestValidator(ctx, "requestValidator", &apigateway.RequestValidatorArgs{
			Name:                      pulumi.String(validatorName),
			RestApiId:                 restApi.ID(),
			ValidateRequestBody:       pulumi.String(validateRequestBody),
			ValidateRequestParameters: pulumi.String(validateRequestParameters),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewMethod(ctx, "method", &apigateway.MethodArgs{
			HttpMethod:        pulumi.String("POST"),
			ResourceId:        restApi.RootResourceId,
			RestApiId:         restApi.ID(),
			AuthorizationType: apigateway.MethodAuthorizationTypeNone,
			Integration: &apigateway.MethodIntegrationArgs{
				Type:            apigateway.MethodIntegrationTypeMock,
				ContentHandling: apigateway.MethodIntegrationContentHandling(contentHandling),
				IntegrationResponses: apigateway.MethodIntegrationResponseArray{
					&apigateway.MethodIntegrationResponseArgs{
						ContentHandling: apigateway.MethodIntegrationResponseContentHandling(contentHandling),
						StatusCode:      pulumi.String("400"),
					},
				},
			},
			RequestValidatorId: requestValidator.ID(),
			OperationName:      pulumi.String(operationName),
		})
		if err != nil {
			return err
		}
		ctx.Export("rootResourceId", restApi.RootResourceId)
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiName := cfg.Require("apiName")
		validatorName := cfg.Require("validatorName")
		validateRequestBody := cfg.Require("validateRequestBody")
		validateRequestParameters := cfg.Require("validateRequestParameters")
		restApi, err := apigateway.NewRestApi(ctx, "restApi", &apigateway.RestApiArgs{
			Name: pulumi.String(apiName),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewRequestValidator(ctx, "requestValidator", &apigateway.RequestValidatorArgs{
			Name:                      pulumi.String(validatorName),
			RestApiId:                 restApi.ID(),
			ValidateRequestBody:       pulumi.String(validateRequestBody),
			ValidateRequestParameters: pulumi.String(validateRequestParameters),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiName := cfg.Require("apiName")
		validatorName := cfg.Require("validatorName")
		validateRequestBody := cfg.Require("validateRequestBody")
		validateRequestParameters := cfg.Require("validateRequestParameters")
		restApi, err := apigateway.NewRestApi(ctx, "restApi", &apigateway.RestApiArgs{
			Name: pulumi.String(apiName),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewRequestValidator(ctx, "requestValidator", &apigateway.RequestValidatorArgs{
			Name:                      pulumi.String(validatorName),
			RestApiId:                 restApi.ID(),
			ValidateRequestBody:       pulumi.String(validateRequestBody),
			ValidateRequestParameters: pulumi.String(validateRequestParameters),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiName := cfg.Require("apiName")
		_type := cfg.Require("type")
		_, err := apigateway.NewRestApi(ctx, "myRestApi", &apigateway.RestApiArgs{
			EndpointConfiguration: &apigateway.RestApiEndpointConfigurationArgs{
				Types: pulumi.StringArray{
					pulumi.String(_type),
				},
			},
			Name: pulumi.String(apiName),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiName := cfg.Require("apiName")
		_type := cfg.Require("type")
		_, err := apigateway.NewRestApi(ctx, "myRestApi", &apigateway.RestApiArgs{
			EndpointConfiguration: &apigateway.RestApiEndpointConfigurationArgs{
				Types: pulumi.StringArray{
					pulumi.String(_type),
				},
			},
			Name: pulumi.String(apiName),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewRestApi(ctx, "restApi", &apigateway.RestApiArgs{
			Body: pulumi.Any(map[string]interface{}{
				"swagger": 2,
				"info": map[string]interface{}{
					"version": "0.0.1",
					"title":   "test",
				},
				"basePath": "/pete",
				"schemes": []string{
					"https",
				},
				"definitions": map[string]interface{}{
					"empty": map[string]interface{}{
						"type": "object",
					},
				},
			}),
			Name: pulumi.String("myApi"),
			Parameters: pulumi.StringMap{
				"endpointConfigurationTypes": pulumi.String("REGIONAL"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewRestApi(ctx, "restApi", &apigateway.RestApiArgs{
			Body: pulumi.Any(map[string]interface{}{
				"swagger": 2,
				"info": map[string]interface{}{
					"version": "0.0.1",
					"title":   "test",
				},
				"basePath": "/pete",
				"schemes": []string{
					"https",
				},
				"definitions": map[string]interface{}{
					"empty": map[string]interface{}{
						"type": "object",
					},
				},
			}),
			Name: pulumi.String("myApi"),
			Parameters: pulumi.StringMap{
				"endpointConfigurationTypes": pulumi.String("REGIONAL"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiKeySourceType := cfg.Require("apiKeySourceType")
		apiName := cfg.Require("apiName")
		binaryMediaType1 := cfg.Require("binaryMediaType1")
		binaryMediaType2 := cfg.Require("binaryMediaType2")
		minimumCompressionSize := cfg.Require("minimumCompressionSize")
		_, err := apigateway.NewRestApi(ctx, "myRestApi", &apigateway.RestApiArgs{
			ApiKeySourceType: pulumi.String(apiKeySourceType),
			BinaryMediaTypes: pulumi.StringArray{
				pulumi.String(binaryMediaType1),
				pulumi.String(binaryMediaType2),
			},
			MinimumCompressionSize: pulumi.String(minimumCompressionSize),
			Name:                   pulumi.String(apiName),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		apiKeySourceType := cfg.Require("apiKeySourceType")
		apiName := cfg.Require("apiName")
		binaryMediaType1 := cfg.Require("binaryMediaType1")
		binaryMediaType2 := cfg.Require("binaryMediaType2")
		minimumCompressionSize := cfg.Require("minimumCompressionSize")
		_, err := apigateway.NewRestApi(ctx, "myRestApi", &apigateway.RestApiArgs{
			ApiKeySourceType: pulumi.String(apiKeySourceType),
			BinaryMediaTypes: pulumi.StringArray{
				pulumi.String(binaryMediaType1),
				pulumi.String(binaryMediaType2),
			},
			MinimumCompressionSize: pulumi.String(minimumCompressionSize),
			Name:                   pulumi.String(apiName),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

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.

func (*RestApi) ElementType 

func (*RestApi) ElementType() reflect.Type

func (*RestApi) ToRestApiOutput 

func (i *RestApi) ToRestApiOutput() RestApiOutput

func (*RestApi) ToRestApiOutputWithContext 

func (i *RestApi) ToRestApiOutputWithContext(ctx context.Context) RestApiOutput

type RestApiArgs 

type RestApiArgs struct {
	// The source of the API key for metering requests according to a usage plan. Valid values are: “HEADER“ to read the API key from the “X-API-Key“ header of a request. “AUTHORIZER“ to read the API key from the “UsageIdentifierKey“ from a custom authorizer.
	ApiKeySourceType 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 a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.
	Body pulumi.Input
	// The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
	BodyS3Location RestApiS3LocationPtrInput
	// The ID of the RestApi that you want to clone from.
	CloneFrom pulumi.StringPtrInput
	// The description of the RestApi.
	Description pulumi.StringPtrInput
	// Specifies whether clients can invoke your API by using the default “execute-api“ endpoint. By default, clients can invoke your API with the default “https://{api_id}.execute-api.{region}.amazonaws.com“ endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
	DisableExecuteApiEndpoint pulumi.BoolPtrInput
	// A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the “Parameters“ property.
	EndpointConfiguration RestApiEndpointConfigurationPtrInput
	// A query parameter to indicate whether to rollback the API update (“true“) or not (“false“) when a warning is encountered. The default value is “false“.
	FailOnWarnings pulumi.BoolPtrInput
	// A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
	MinimumCompressionSize pulumi.IntPtrInput
	// This property applies only when you use OpenAPI to define your REST API. The “Mode“ determines how API Gateway handles resource updates.
	//  Valid values are “overwrite“ or “merge“.
	//  For “overwrite“, the new API definition replaces the existing one. The existing API identifier remains unchanged.
	//   For “merge“, the new API definition is merged with the existing API.
	//  If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is “overwrite“. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
	//  Use the default mode to define top-level “RestApi“ properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
	Mode pulumi.StringPtrInput
	// The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
	Name pulumi.StringPtrInput
	// Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set “ignore=documentation“ as a “parameters“ value, as in the AWS CLI command of “aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'“.
	Parameters pulumi.StringMapInput
	// A policy document that contains the permissions for the “RestApi“ resource. To set the ARN for the policy, use the “!Join“ intrinsic function with “""“ as delimiter and values of “"execute-api:/"“ and “"*"“.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.
	Policy pulumi.Input
	// The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a RestApi resource.

func (RestApiArgs) ElementType 

func (RestApiArgs) ElementType() reflect.Type

type RestApiEndpointConfiguration 

type RestApiEndpointConfiguration struct {
	// A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is “"EDGE"“. For a regional API and its custom domain name, the endpoint type is “REGIONAL“. For a private API, the endpoint type is “PRIVATE“.
	Types []string `pulumi:"types"`
	// A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for “PRIVATE“ endpoint type.
	VpcEndpointIds []string `pulumi:"vpcEndpointIds"`
}

The “EndpointConfiguration“ property type specifies the endpoint types of a REST API. 

``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.

type RestApiEndpointConfigurationArgs 

type RestApiEndpointConfigurationArgs struct {
	// A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is “"EDGE"“. For a regional API and its custom domain name, the endpoint type is “REGIONAL“. For a private API, the endpoint type is “PRIVATE“.
	Types pulumi.StringArrayInput `pulumi:"types"`
	// A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for “PRIVATE“ endpoint type.
	VpcEndpointIds pulumi.StringArrayInput `pulumi:"vpcEndpointIds"`
}

The “EndpointConfiguration“ property type specifies the endpoint types of a REST API. 

``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.

func (RestApiEndpointConfigurationArgs) ElementType 

func (RestApiEndpointConfigurationArgs) ElementType() reflect.Type

func (RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationOutput 

func (i RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationOutput() RestApiEndpointConfigurationOutput

func (RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationOutputWithContext 

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

func (RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationPtrOutput 

func (i RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationPtrOutput() RestApiEndpointConfigurationPtrOutput

func (RestApiEndpointConfigurationArgs) ToRestApiEndpointConfigurationPtrOutputWithContext 

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

type RestApiEndpointConfigurationInput 

type RestApiEndpointConfigurationInput interface {
	pulumi.Input

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

RestApiEndpointConfigurationInput is an input type that accepts RestApiEndpointConfigurationArgs and RestApiEndpointConfigurationOutput values. You can construct a concrete instance of `RestApiEndpointConfigurationInput` via: 

RestApiEndpointConfigurationArgs{...}

type RestApiEndpointConfigurationOutput 

type RestApiEndpointConfigurationOutput struct{ *pulumi.OutputState }

The “EndpointConfiguration“ property type specifies the endpoint types of a REST API. 

``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.

func (RestApiEndpointConfigurationOutput) ElementType 

func (RestApiEndpointConfigurationOutput) ElementType() reflect.Type

func (RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationOutput 

func (o RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationOutput() RestApiEndpointConfigurationOutput

func (RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationOutputWithContext 

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

func (RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationPtrOutput 

func (o RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationPtrOutput() RestApiEndpointConfigurationPtrOutput

func (RestApiEndpointConfigurationOutput) ToRestApiEndpointConfigurationPtrOutputWithContext 

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

func (RestApiEndpointConfigurationOutput) Types 

func (o RestApiEndpointConfigurationOutput) Types() pulumi.StringArrayOutput

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is “"EDGE"“. For a regional API and its custom domain name, the endpoint type is “REGIONAL“. For a private API, the endpoint type is “PRIVATE“.

func (RestApiEndpointConfigurationOutput) VpcEndpointIds 

func (o RestApiEndpointConfigurationOutput) VpcEndpointIds() pulumi.StringArrayOutput

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for “PRIVATE“ endpoint type.

type RestApiEndpointConfigurationPtrInput 

type RestApiEndpointConfigurationPtrInput interface {
	pulumi.Input

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

RestApiEndpointConfigurationPtrInput is an input type that accepts RestApiEndpointConfigurationArgs, RestApiEndpointConfigurationPtr and RestApiEndpointConfigurationPtrOutput values. You can construct a concrete instance of `RestApiEndpointConfigurationPtrInput` via: 

        RestApiEndpointConfigurationArgs{...}

or:

        nil

func RestApiEndpointConfigurationPtr 

func RestApiEndpointConfigurationPtr(v *RestApiEndpointConfigurationArgs) RestApiEndpointConfigurationPtrInput

type RestApiEndpointConfigurationPtrOutput 

type RestApiEndpointConfigurationPtrOutput struct{ *pulumi.OutputState }

func (RestApiEndpointConfigurationPtrOutput) Elem 

func (o RestApiEndpointConfigurationPtrOutput) Elem() RestApiEndpointConfigurationOutput

func (RestApiEndpointConfigurationPtrOutput) ElementType 

func (RestApiEndpointConfigurationPtrOutput) ElementType() reflect.Type

func (RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutput 

func (o RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutput() RestApiEndpointConfigurationPtrOutput

func (RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutputWithContext 

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

func (RestApiEndpointConfigurationPtrOutput) Types 

func (o RestApiEndpointConfigurationPtrOutput) Types() pulumi.StringArrayOutput

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is “"EDGE"“. For a regional API and its custom domain name, the endpoint type is “REGIONAL“. For a private API, the endpoint type is “PRIVATE“.

func (RestApiEndpointConfigurationPtrOutput) VpcEndpointIds 

func (o RestApiEndpointConfigurationPtrOutput) VpcEndpointIds() pulumi.StringArrayOutput

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for “PRIVATE“ endpoint type.

type RestApiInput 

type RestApiInput interface {
	pulumi.Input

	ToRestApiOutput() RestApiOutput
	ToRestApiOutputWithContext(ctx context.Context) RestApiOutput
}

type RestApiOutput 

type RestApiOutput struct{ *pulumi.OutputState }

func (RestApiOutput) ApiKeySourceType added in v0.17.0 

func (o RestApiOutput) ApiKeySourceType() pulumi.StringPtrOutput

The source of the API key for metering requests according to a usage plan. Valid values are: “HEADER“ to read the API key from the “X-API-Key“ header of a request. “AUTHORIZER“ to read the API key from the “UsageIdentifierKey“ from a custom authorizer.

func (RestApiOutput) BinaryMediaTypes added in v0.17.0 

func (o RestApiOutput) BinaryMediaTypes() pulumi.StringArrayOutput

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

func (RestApiOutput) Body added in v0.17.0 

func (o RestApiOutput) Body() pulumi.AnyOutput

An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.

func (RestApiOutput) BodyS3Location added in v0.17.0 

func (o RestApiOutput) BodyS3Location() RestApiS3LocationPtrOutput

The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.

func (RestApiOutput) CloneFrom added in v0.17.0 

func (o RestApiOutput) CloneFrom() pulumi.StringPtrOutput

The ID of the RestApi that you want to clone from.

func (RestApiOutput) Description added in v0.17.0 

func (o RestApiOutput) Description() pulumi.StringPtrOutput

The description of the RestApi.

func (RestApiOutput) DisableExecuteApiEndpoint added in v0.17.0 

func (o RestApiOutput) DisableExecuteApiEndpoint() pulumi.BoolPtrOutput

Specifies whether clients can invoke your API by using the default “execute-api“ endpoint. By default, clients can invoke your API with the default “https://{api_id}.execute-api.{region}.amazonaws.com“ endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint

func (RestApiOutput) ElementType 

func (RestApiOutput) ElementType() reflect.Type

func (RestApiOutput) EndpointConfiguration added in v0.17.0 

func (o RestApiOutput) EndpointConfiguration() RestApiEndpointConfigurationPtrOutput

A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the “Parameters“ property.

func (RestApiOutput) FailOnWarnings added in v0.17.0 

func (o RestApiOutput) FailOnWarnings() pulumi.BoolPtrOutput

A query parameter to indicate whether to rollback the API update (“true“) or not (“false“) when a warning is encountered. The default value is “false“.

func (RestApiOutput) MinimumCompressionSize added in v0.17.0 

func (o RestApiOutput) MinimumCompressionSize() pulumi.IntPtrOutput

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

func (RestApiOutput) Mode added in v0.17.0 

func (o RestApiOutput) Mode() pulumi.StringPtrOutput

This property applies only when you use OpenAPI to define your REST API. The “Mode“ determines how API Gateway handles resource updates. 

Valid values are ``overwrite`` or ``merge``.
For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.
 For ``merge``, the new API definition is merged with the existing API.
If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.

func (RestApiOutput) Name added in v0.17.0 

func (o RestApiOutput) Name() pulumi.StringPtrOutput

The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.

func (RestApiOutput) Parameters added in v0.17.0 

func (o RestApiOutput) Parameters() pulumi.StringMapOutput

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set “ignore=documentation“ as a “parameters“ value, as in the AWS CLI command of “aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'“.

func (RestApiOutput) Policy added in v0.17.0 

func (o RestApiOutput) Policy() pulumi.AnyOutput

A policy document that contains the permissions for the “RestApi“ resource. To set the ARN for the policy, use the “!Join“ intrinsic function with “""“ as delimiter and values of “"execute-api:/"“ and “"*"“.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.

func (RestApiOutput) RestApiId added in v0.44.0 

func (o RestApiOutput) RestApiId() pulumi.StringOutput

func (RestApiOutput) RootResourceId added in v0.17.0 

func (o RestApiOutput) RootResourceId() pulumi.StringOutput

func (RestApiOutput) Tags added in v0.17.0 

func (o RestApiOutput) Tags() aws.TagArrayOutput

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with “aws:“. The tag value can be up to 256 characters.

func (RestApiOutput) ToRestApiOutput 

func (o RestApiOutput) ToRestApiOutput() RestApiOutput

func (RestApiOutput) ToRestApiOutputWithContext 

func (o RestApiOutput) ToRestApiOutputWithContext(ctx context.Context) RestApiOutput

type RestApiS3Location 

type RestApiS3Location struct {
	// The name of the S3 bucket where the OpenAPI file is stored.
	Bucket *string `pulumi:"bucket"`
	// The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
	ETag *string `pulumi:"eTag"`
	// The file name of the OpenAPI file (Amazon S3 object name).
	Key *string `pulumi:"key"`
	// For versioning-enabled buckets, a specific version of the OpenAPI file.
	Version *string `pulumi:"version"`
}

“S3Location“ is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. 

On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.

type RestApiS3LocationArgs 

type RestApiS3LocationArgs struct {
	// The name of the S3 bucket where the OpenAPI file is stored.
	Bucket pulumi.StringPtrInput `pulumi:"bucket"`
	// The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
	ETag pulumi.StringPtrInput `pulumi:"eTag"`
	// The file name of the OpenAPI file (Amazon S3 object name).
	Key pulumi.StringPtrInput `pulumi:"key"`
	// For versioning-enabled buckets, a specific version of the OpenAPI file.
	Version pulumi.StringPtrInput `pulumi:"version"`
}

“S3Location“ is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. 

On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.

func (RestApiS3LocationArgs) ElementType 

func (RestApiS3LocationArgs) ElementType() reflect.Type

func (RestApiS3LocationArgs) ToRestApiS3LocationOutput 

func (i RestApiS3LocationArgs) ToRestApiS3LocationOutput() RestApiS3LocationOutput

func (RestApiS3LocationArgs) ToRestApiS3LocationOutputWithContext 

func (i RestApiS3LocationArgs) ToRestApiS3LocationOutputWithContext(ctx context.Context) RestApiS3LocationOutput

func (RestApiS3LocationArgs) ToRestApiS3LocationPtrOutput 

func (i RestApiS3LocationArgs) ToRestApiS3LocationPtrOutput() RestApiS3LocationPtrOutput

func (RestApiS3LocationArgs) ToRestApiS3LocationPtrOutputWithContext 

func (i RestApiS3LocationArgs) ToRestApiS3LocationPtrOutputWithContext(ctx context.Context) RestApiS3LocationPtrOutput

type RestApiS3LocationInput 

type RestApiS3LocationInput interface {
	pulumi.Input

	ToRestApiS3LocationOutput() RestApiS3LocationOutput
	ToRestApiS3LocationOutputWithContext(context.Context) RestApiS3LocationOutput
}

RestApiS3LocationInput is an input type that accepts RestApiS3LocationArgs and RestApiS3LocationOutput values. You can construct a concrete instance of `RestApiS3LocationInput` via: 

RestApiS3LocationArgs{...}

type RestApiS3LocationOutput 

type RestApiS3LocationOutput struct{ *pulumi.OutputState }

“S3Location“ is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. 

On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.

func (RestApiS3LocationOutput) Bucket 

func (o RestApiS3LocationOutput) Bucket() pulumi.StringPtrOutput

The name of the S3 bucket where the OpenAPI file is stored.

func (RestApiS3LocationOutput) ETag 

func (o RestApiS3LocationOutput) ETag() pulumi.StringPtrOutput

The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.

func (RestApiS3LocationOutput) ElementType 

func (RestApiS3LocationOutput) ElementType() reflect.Type

func (RestApiS3LocationOutput) Key 

func (o RestApiS3LocationOutput) Key() pulumi.StringPtrOutput

The file name of the OpenAPI file (Amazon S3 object name).

func (RestApiS3LocationOutput) ToRestApiS3LocationOutput 

func (o RestApiS3LocationOutput) ToRestApiS3LocationOutput() RestApiS3LocationOutput

func (RestApiS3LocationOutput) ToRestApiS3LocationOutputWithContext 

func (o RestApiS3LocationOutput) ToRestApiS3LocationOutputWithContext(ctx context.Context) RestApiS3LocationOutput

func (RestApiS3LocationOutput) ToRestApiS3LocationPtrOutput 

func (o RestApiS3LocationOutput) ToRestApiS3LocationPtrOutput() RestApiS3LocationPtrOutput

func (RestApiS3LocationOutput) ToRestApiS3LocationPtrOutputWithContext 

func (o RestApiS3LocationOutput) ToRestApiS3LocationPtrOutputWithContext(ctx context.Context) RestApiS3LocationPtrOutput

func (RestApiS3LocationOutput) Version 

func (o RestApiS3LocationOutput) Version() pulumi.StringPtrOutput

For versioning-enabled buckets, a specific version of the OpenAPI file.

type RestApiS3LocationPtrInput 

type RestApiS3LocationPtrInput interface {
	pulumi.Input

	ToRestApiS3LocationPtrOutput() RestApiS3LocationPtrOutput
	ToRestApiS3LocationPtrOutputWithContext(context.Context) RestApiS3LocationPtrOutput
}

RestApiS3LocationPtrInput is an input type that accepts RestApiS3LocationArgs, RestApiS3LocationPtr and RestApiS3LocationPtrOutput values. You can construct a concrete instance of `RestApiS3LocationPtrInput` via: 

        RestApiS3LocationArgs{...}

or:

        nil

func RestApiS3LocationPtr 

func RestApiS3LocationPtr(v *RestApiS3LocationArgs) RestApiS3LocationPtrInput

type RestApiS3LocationPtrOutput 

type RestApiS3LocationPtrOutput struct{ *pulumi.OutputState }

func (RestApiS3LocationPtrOutput) Bucket 

func (o RestApiS3LocationPtrOutput) Bucket() pulumi.StringPtrOutput

The name of the S3 bucket where the OpenAPI file is stored.

func (RestApiS3LocationPtrOutput) ETag 

func (o RestApiS3LocationPtrOutput) ETag() pulumi.StringPtrOutput

The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.

func (RestApiS3LocationPtrOutput) Elem 

func (o RestApiS3LocationPtrOutput) Elem() RestApiS3LocationOutput

func (RestApiS3LocationPtrOutput) ElementType 

func (RestApiS3LocationPtrOutput) ElementType() reflect.Type

func (RestApiS3LocationPtrOutput) Key 

func (o RestApiS3LocationPtrOutput) Key() pulumi.StringPtrOutput

The file name of the OpenAPI file (Amazon S3 object name).

func (RestApiS3LocationPtrOutput) ToRestApiS3LocationPtrOutput 

func (o RestApiS3LocationPtrOutput) ToRestApiS3LocationPtrOutput() RestApiS3LocationPtrOutput

func (RestApiS3LocationPtrOutput) ToRestApiS3LocationPtrOutputWithContext 

func (o RestApiS3LocationPtrOutput) ToRestApiS3LocationPtrOutputWithContext(ctx context.Context) RestApiS3LocationPtrOutput

func (RestApiS3LocationPtrOutput) Version 

func (o RestApiS3LocationPtrOutput) Version() pulumi.StringPtrOutput

For versioning-enabled buckets, a specific version of the OpenAPI file.

type RestApiState 

type RestApiState struct {
}

func (RestApiState) ElementType 

func (RestApiState) ElementType() reflect.Type

type RestApiTag 

type RestApiTag struct {
	Key   string `pulumi:"key"`
	Value string `pulumi:"value"`
}

type Stage 

type Stage struct {
	pulumi.CustomResourceState

	// Access log settings, including the access log format and access log destination ARN.
	AccessLogSetting StageAccessLogSettingPtrOutput `pulumi:"accessLogSetting"`
	// Specifies whether a cache cluster is enabled for the stage.
	CacheClusterEnabled pulumi.BoolPtrOutput `pulumi:"cacheClusterEnabled"`
	// The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
	CacheClusterSize pulumi.StringPtrOutput `pulumi:"cacheClusterSize"`
	// Settings for the canary deployment in this stage.
	CanarySetting StageCanarySettingPtrOutput `pulumi:"canarySetting"`
	// The identifier of a client certificate for an API stage.
	ClientCertificateId pulumi.StringPtrOutput `pulumi:"clientCertificateId"`
	// The identifier of the Deployment that the stage points to.
	DeploymentId pulumi.StringPtrOutput `pulumi:"deploymentId"`
	// The stage's description.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The version of the associated API documentation.
	DocumentationVersion pulumi.StringPtrOutput `pulumi:"documentationVersion"`
	// A map that defines the method settings for a Stage resource. Keys (designated as “/{method_setting_key“ below) are method paths defined as “{resource_path}/{http_method}“ for an individual method override, or “/\*/\*“ for overriding all methods in the stage.
	MethodSettings StageMethodSettingArrayOutput `pulumi:"methodSettings"`
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
	StageName pulumi.StringPtrOutput `pulumi:"stageName"`
	// The collection of tags. Each tag element is associated with a given resource.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// Specifies whether active tracing with X-ray is enabled for the Stage.
	TracingEnabled pulumi.BoolPtrOutput `pulumi:"tracingEnabled"`
	// A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: “[A-Za-z0-9-._~:/?#&=,]+“.
	Variables pulumi.StringMapOutput `pulumi:"variables"`
}

The “AWS::ApiGateway::Stage“ resource creates a stage for a deployment.

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.

func (*Stage) ElementType 

func (*Stage) ElementType() reflect.Type

func (*Stage) ToStageOutput 

func (i *Stage) ToStageOutput() StageOutput

func (*Stage) ToStageOutputWithContext 

func (i *Stage) ToStageOutputWithContext(ctx context.Context) StageOutput

type StageAccessLogSetting 

type StageAccessLogSetting 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-“. This parameter is required to enable access logging.
	DestinationArn *string `pulumi:"destinationArn"`
	// A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least “$context.requestId“. This parameter is required to enable access logging.
	Format *string `pulumi:"format"`
}

The “AccessLogSetting“ property type specifies settings for logging access in this stage. 

``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.

type StageAccessLogSettingArgs 

type StageAccessLogSettingArgs 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-“. This parameter is required to enable access logging.
	DestinationArn pulumi.StringPtrInput `pulumi:"destinationArn"`
	// A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least “$context.requestId“. This parameter is required to enable access logging.
	Format pulumi.StringPtrInput `pulumi:"format"`
}

The “AccessLogSetting“ property type specifies settings for logging access in this stage. 

``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.

func (StageAccessLogSettingArgs) ElementType 

func (StageAccessLogSettingArgs) ElementType() reflect.Type

func (StageAccessLogSettingArgs) ToStageAccessLogSettingOutput 

func (i StageAccessLogSettingArgs) ToStageAccessLogSettingOutput() StageAccessLogSettingOutput

func (StageAccessLogSettingArgs) ToStageAccessLogSettingOutputWithContext 

func (i StageAccessLogSettingArgs) ToStageAccessLogSettingOutputWithContext(ctx context.Context) StageAccessLogSettingOutput

func (StageAccessLogSettingArgs) ToStageAccessLogSettingPtrOutput 

func (i StageAccessLogSettingArgs) ToStageAccessLogSettingPtrOutput() StageAccessLogSettingPtrOutput

func (StageAccessLogSettingArgs) ToStageAccessLogSettingPtrOutputWithContext 

func (i StageAccessLogSettingArgs) ToStageAccessLogSettingPtrOutputWithContext(ctx context.Context) StageAccessLogSettingPtrOutput

type StageAccessLogSettingInput 

type StageAccessLogSettingInput interface {
	pulumi.Input

	ToStageAccessLogSettingOutput() StageAccessLogSettingOutput
	ToStageAccessLogSettingOutputWithContext(context.Context) StageAccessLogSettingOutput
}

StageAccessLogSettingInput is an input type that accepts StageAccessLogSettingArgs and StageAccessLogSettingOutput values. You can construct a concrete instance of `StageAccessLogSettingInput` via: 

StageAccessLogSettingArgs{...}

type StageAccessLogSettingOutput 

type StageAccessLogSettingOutput struct{ *pulumi.OutputState }

The “AccessLogSetting“ property type specifies settings for logging access in this stage. 

``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.

func (StageAccessLogSettingOutput) DestinationArn 

func (o StageAccessLogSettingOutput) DestinationArn() pulumi.StringPtrOutput

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-“. This parameter is required to enable access logging.

func (StageAccessLogSettingOutput) ElementType 

func (StageAccessLogSettingOutput) ElementType() reflect.Type

func (StageAccessLogSettingOutput) Format 

func (o StageAccessLogSettingOutput) Format() pulumi.StringPtrOutput

A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least “$context.requestId“. This parameter is required to enable access logging.

func (StageAccessLogSettingOutput) ToStageAccessLogSettingOutput 

func (o StageAccessLogSettingOutput) ToStageAccessLogSettingOutput() StageAccessLogSettingOutput

func (StageAccessLogSettingOutput) ToStageAccessLogSettingOutputWithContext 

func (o StageAccessLogSettingOutput) ToStageAccessLogSettingOutputWithContext(ctx context.Context) StageAccessLogSettingOutput

func (StageAccessLogSettingOutput) ToStageAccessLogSettingPtrOutput 

func (o StageAccessLogSettingOutput) ToStageAccessLogSettingPtrOutput() StageAccessLogSettingPtrOutput

func (StageAccessLogSettingOutput) ToStageAccessLogSettingPtrOutputWithContext 

func (o StageAccessLogSettingOutput) ToStageAccessLogSettingPtrOutputWithContext(ctx context.Context) StageAccessLogSettingPtrOutput

type StageAccessLogSettingPtrInput 

type StageAccessLogSettingPtrInput interface {
	pulumi.Input

	ToStageAccessLogSettingPtrOutput() StageAccessLogSettingPtrOutput
	ToStageAccessLogSettingPtrOutputWithContext(context.Context) StageAccessLogSettingPtrOutput
}

StageAccessLogSettingPtrInput is an input type that accepts StageAccessLogSettingArgs, StageAccessLogSettingPtr and StageAccessLogSettingPtrOutput values. You can construct a concrete instance of `StageAccessLogSettingPtrInput` via: 

        StageAccessLogSettingArgs{...}

or:

        nil

func StageAccessLogSettingPtr 

func StageAccessLogSettingPtr(v *StageAccessLogSettingArgs) StageAccessLogSettingPtrInput

type StageAccessLogSettingPtrOutput 

type StageAccessLogSettingPtrOutput struct{ *pulumi.OutputState }

func (StageAccessLogSettingPtrOutput) DestinationArn 

func (o StageAccessLogSettingPtrOutput) DestinationArn() pulumi.StringPtrOutput

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-“. This parameter is required to enable access logging.

func (StageAccessLogSettingPtrOutput) Elem 

func (o StageAccessLogSettingPtrOutput) Elem() StageAccessLogSettingOutput

func (StageAccessLogSettingPtrOutput) ElementType 

func (StageAccessLogSettingPtrOutput) ElementType() reflect.Type

func (StageAccessLogSettingPtrOutput) Format 

func (o StageAccessLogSettingPtrOutput) Format() pulumi.StringPtrOutput

A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least “$context.requestId“. This parameter is required to enable access logging.

func (StageAccessLogSettingPtrOutput) ToStageAccessLogSettingPtrOutput 

func (o StageAccessLogSettingPtrOutput) ToStageAccessLogSettingPtrOutput() StageAccessLogSettingPtrOutput

func (StageAccessLogSettingPtrOutput) ToStageAccessLogSettingPtrOutputWithContext 

func (o StageAccessLogSettingPtrOutput) ToStageAccessLogSettingPtrOutputWithContext(ctx context.Context) StageAccessLogSettingPtrOutput

type StageArgs 

type StageArgs struct {
	// Access log settings, including the access log format and access log destination ARN.
	AccessLogSetting StageAccessLogSettingPtrInput
	// Specifies whether a cache cluster is enabled for the stage.
	CacheClusterEnabled pulumi.BoolPtrInput
	// The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
	CacheClusterSize pulumi.StringPtrInput
	// Settings for the canary deployment in this stage.
	CanarySetting StageCanarySettingPtrInput
	// The identifier of a client certificate for an API stage.
	ClientCertificateId pulumi.StringPtrInput
	// The identifier of the Deployment that the stage points to.
	DeploymentId pulumi.StringPtrInput
	// The stage's description.
	Description pulumi.StringPtrInput
	// The version of the associated API documentation.
	DocumentationVersion pulumi.StringPtrInput
	// A map that defines the method settings for a Stage resource. Keys (designated as “/{method_setting_key“ below) are method paths defined as “{resource_path}/{http_method}“ for an individual method override, or “/\*/\*“ for overriding all methods in the stage.
	MethodSettings StageMethodSettingArrayInput
	// The string identifier of the associated RestApi.
	RestApiId pulumi.StringInput
	// The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
	StageName pulumi.StringPtrInput
	// The collection of tags. Each tag element is associated with a given resource.
	Tags aws.TagArrayInput
	// Specifies whether active tracing with X-ray is enabled for the Stage.
	TracingEnabled pulumi.BoolPtrInput
	// A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: “[A-Za-z0-9-._~:/?#&=,]+“.
	Variables pulumi.StringMapInput
}

The set of arguments for constructing a Stage resource.

func (StageArgs) ElementType 

func (StageArgs) ElementType() reflect.Type

type StageCanarySetting 

type StageCanarySetting struct {
	// The ID of the canary deployment.
	DeploymentId *string `pulumi:"deploymentId"`
	// The percent (0-100) of traffic diverted to a canary deployment.
	PercentTraffic *float64 `pulumi:"percentTraffic"`
	// Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
	StageVariableOverrides map[string]string `pulumi:"stageVariableOverrides"`
	// A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
	UseStageCache *bool `pulumi:"useStageCache"`
}

Configuration settings of a canary deployment.

type StageCanarySettingArgs 

type StageCanarySettingArgs struct {
	// The ID of the canary deployment.
	DeploymentId pulumi.StringPtrInput `pulumi:"deploymentId"`
	// The percent (0-100) of traffic diverted to a canary deployment.
	PercentTraffic pulumi.Float64PtrInput `pulumi:"percentTraffic"`
	// Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
	StageVariableOverrides pulumi.StringMapInput `pulumi:"stageVariableOverrides"`
	// A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
	UseStageCache pulumi.BoolPtrInput `pulumi:"useStageCache"`
}

Configuration settings of a canary deployment.

func (StageCanarySettingArgs) ElementType 

func (StageCanarySettingArgs) ElementType() reflect.Type

func (StageCanarySettingArgs) ToStageCanarySettingOutput 

func (i StageCanarySettingArgs) ToStageCanarySettingOutput() StageCanarySettingOutput

func (StageCanarySettingArgs) ToStageCanarySettingOutputWithContext 

func (i StageCanarySettingArgs) ToStageCanarySettingOutputWithContext(ctx context.Context) StageCanarySettingOutput

func (StageCanarySettingArgs) ToStageCanarySettingPtrOutput 

func (i StageCanarySettingArgs) ToStageCanarySettingPtrOutput() StageCanarySettingPtrOutput

func (StageCanarySettingArgs) ToStageCanarySettingPtrOutputWithContext 

func (i StageCanarySettingArgs) ToStageCanarySettingPtrOutputWithContext(ctx context.Context) StageCanarySettingPtrOutput

type StageCanarySettingInput 

type StageCanarySettingInput interface {
	pulumi.Input

	ToStageCanarySettingOutput() StageCanarySettingOutput
	ToStageCanarySettingOutputWithContext(context.Context) StageCanarySettingOutput
}

StageCanarySettingInput is an input type that accepts StageCanarySettingArgs and StageCanarySettingOutput values. You can construct a concrete instance of `StageCanarySettingInput` via: 

StageCanarySettingArgs{...}

type StageCanarySettingOutput 

type StageCanarySettingOutput struct{ *pulumi.OutputState }

Configuration settings of a canary deployment.

func (StageCanarySettingOutput) DeploymentId 

func (o StageCanarySettingOutput) DeploymentId() pulumi.StringPtrOutput

The ID of the canary deployment.

func (StageCanarySettingOutput) ElementType 

func (StageCanarySettingOutput) ElementType() reflect.Type

func (StageCanarySettingOutput) PercentTraffic 

func (o StageCanarySettingOutput) PercentTraffic() pulumi.Float64PtrOutput

The percent (0-100) of traffic diverted to a canary deployment.

func (StageCanarySettingOutput) StageVariableOverrides 

func (o StageCanarySettingOutput) StageVariableOverrides() pulumi.StringMapOutput

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

func (StageCanarySettingOutput) ToStageCanarySettingOutput 

func (o StageCanarySettingOutput) ToStageCanarySettingOutput() StageCanarySettingOutput

func (StageCanarySettingOutput) ToStageCanarySettingOutputWithContext 

func (o StageCanarySettingOutput) ToStageCanarySettingOutputWithContext(ctx context.Context) StageCanarySettingOutput

func (StageCanarySettingOutput) ToStageCanarySettingPtrOutput 

func (o StageCanarySettingOutput) ToStageCanarySettingPtrOutput() StageCanarySettingPtrOutput

func (StageCanarySettingOutput) ToStageCanarySettingPtrOutputWithContext 

func (o StageCanarySettingOutput) ToStageCanarySettingPtrOutputWithContext(ctx context.Context) StageCanarySettingPtrOutput

func (StageCanarySettingOutput) UseStageCache 

func (o StageCanarySettingOutput) UseStageCache() pulumi.BoolPtrOutput

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

type StageCanarySettingPtrInput 

type StageCanarySettingPtrInput interface {
	pulumi.Input

	ToStageCanarySettingPtrOutput() StageCanarySettingPtrOutput
	ToStageCanarySettingPtrOutputWithContext(context.Context) StageCanarySettingPtrOutput
}

StageCanarySettingPtrInput is an input type that accepts StageCanarySettingArgs, StageCanarySettingPtr and StageCanarySettingPtrOutput values. You can construct a concrete instance of `StageCanarySettingPtrInput` via: 

        StageCanarySettingArgs{...}

or:

        nil

func StageCanarySettingPtr 

func StageCanarySettingPtr(v *StageCanarySettingArgs) StageCanarySettingPtrInput

type StageCanarySettingPtrOutput 

type StageCanarySettingPtrOutput struct{ *pulumi.OutputState }

func (StageCanarySettingPtrOutput) DeploymentId 

func (o StageCanarySettingPtrOutput) DeploymentId() pulumi.StringPtrOutput

The ID of the canary deployment.

func (StageCanarySettingPtrOutput) Elem 

func (o StageCanarySettingPtrOutput) Elem() StageCanarySettingOutput

func (StageCanarySettingPtrOutput) ElementType 

func (StageCanarySettingPtrOutput) ElementType() reflect.Type

func (StageCanarySettingPtrOutput) PercentTraffic 

func (o StageCanarySettingPtrOutput) PercentTraffic() pulumi.Float64PtrOutput

The percent (0-100) of traffic diverted to a canary deployment.

func (StageCanarySettingPtrOutput) StageVariableOverrides 

func (o StageCanarySettingPtrOutput) StageVariableOverrides() pulumi.StringMapOutput

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

func (StageCanarySettingPtrOutput) ToStageCanarySettingPtrOutput 

func (o StageCanarySettingPtrOutput) ToStageCanarySettingPtrOutput() StageCanarySettingPtrOutput

func (StageCanarySettingPtrOutput) ToStageCanarySettingPtrOutputWithContext 

func (o StageCanarySettingPtrOutput) ToStageCanarySettingPtrOutputWithContext(ctx context.Context) StageCanarySettingPtrOutput

func (StageCanarySettingPtrOutput) UseStageCache 

func (o StageCanarySettingPtrOutput) UseStageCache() pulumi.BoolPtrOutput

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

type StageInput 

type StageInput interface {
	pulumi.Input

	ToStageOutput() StageOutput
	ToStageOutputWithContext(ctx context.Context) StageOutput
}

type StageMethodSetting 

type StageMethodSetting 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 affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
	DataTraceEnabled *bool `pulumi:"dataTraceEnabled"`
	// The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (“*“) for the “HttpMethod“ and “/*“ for the “ResourcePath“. This parameter is required when you specify a “MethodSetting“.
	HttpMethod *string `pulumi:"httpMethod"`
	// Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are “OFF“, “ERROR“, and “INFO“. Choose “ERROR“ to write only error-level entries to CloudWatch Logs, or choose “INFO“ to include all “ERROR“ events as well as extra informational events.
	LoggingLevel *string `pulumi:"loggingLevel"`
	// Specifies whether Amazon CloudWatch metrics are enabled for this method.
	MetricsEnabled *bool `pulumi:"metricsEnabled"`
	// The resource path for this method. Forward slashes (“/“) are encoded as “~1“ and the initial slash must include a forward slash. For example, the path value “/resource/subresource“ must be encoded as “/~1resource~1subresource“. To specify the root path, use only a slash (“/“). To apply settings to multiple resources and methods, specify an asterisk (“*“) for the “HttpMethod“ and “/*“ for the “ResourcePath“. This parameter is required when you specify a “MethodSetting“.
	ResourcePath *string `pulumi:"resourcePath"`
	// Specifies the throttling burst limit.
	ThrottlingBurstLimit *int `pulumi:"throttlingBurstLimit"`
	// Specifies the throttling rate limit.
	ThrottlingRateLimit *float64 `pulumi:"throttlingRateLimit"`
}

The “MethodSetting“ property type configures settings for all methods in a stage. 

The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types.

type StageMethodSettingArgs 

type StageMethodSettingArgs 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 affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
	DataTraceEnabled pulumi.BoolPtrInput `pulumi:"dataTraceEnabled"`
	// The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (“*“) for the “HttpMethod“ and “/*“ for the “ResourcePath“. This parameter is required when you specify a “MethodSetting“.
	HttpMethod pulumi.StringPtrInput `pulumi:"httpMethod"`
	// Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are “OFF“, “ERROR“, and “INFO“. Choose “ERROR“ to write only error-level entries to CloudWatch Logs, or choose “INFO“ to include all “ERROR“ events as well as extra informational events.
	LoggingLevel pulumi.StringPtrInput `pulumi:"loggingLevel"`
	// Specifies whether Amazon CloudWatch metrics are enabled for this method.
	MetricsEnabled pulumi.BoolPtrInput `pulumi:"metricsEnabled"`
	// The resource path for this method. Forward slashes (“/“) are encoded as “~1“ and the initial slash must include a forward slash. For example, the path value “/resource/subresource“ must be encoded as “/~1resource~1subresource“. To specify the root path, use only a slash (“/“). To apply settings to multiple resources and methods, specify an asterisk (“*“) for the “HttpMethod“ and “/*“ for the “ResourcePath“. This parameter is required when you specify a “MethodSetting“.
	ResourcePath pulumi.StringPtrInput `pulumi:"resourcePath"`
	// Specifies the throttling burst limit.
	ThrottlingBurstLimit pulumi.IntPtrInput `pulumi:"throttlingBurstLimit"`
	// Specifies the throttling rate limit.
	ThrottlingRateLimit pulumi.Float64PtrInput `pulumi:"throttlingRateLimit"`
}

The “MethodSetting“ property type configures settings for all methods in a stage. 

The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types.

func (StageMethodSettingArgs) ElementType 

func (StageMethodSettingArgs) ElementType() reflect.Type

func (StageMethodSettingArgs) ToStageMethodSettingOutput 

func (i StageMethodSettingArgs) ToStageMethodSettingOutput() StageMethodSettingOutput

func (StageMethodSettingArgs) ToStageMethodSettingOutputWithContext 

func (i StageMethodSettingArgs) ToStageMethodSettingOutputWithContext(ctx context.Context) StageMethodSettingOutput

type StageMethodSettingArray 

type StageMethodSettingArray []StageMethodSettingInput

func (StageMethodSettingArray) ElementType 

func (StageMethodSettingArray) ElementType() reflect.Type

func (StageMethodSettingArray) ToStageMethodSettingArrayOutput 

func (i StageMethodSettingArray) ToStageMethodSettingArrayOutput() StageMethodSettingArrayOutput

func (StageMethodSettingArray) ToStageMethodSettingArrayOutputWithContext 

func (i StageMethodSettingArray) ToStageMethodSettingArrayOutputWithContext(ctx context.Context) StageMethodSettingArrayOutput

type StageMethodSettingArrayInput 

type StageMethodSettingArrayInput interface {
	pulumi.Input

	ToStageMethodSettingArrayOutput() StageMethodSettingArrayOutput
	ToStageMethodSettingArrayOutputWithContext(context.Context) StageMethodSettingArrayOutput
}

StageMethodSettingArrayInput is an input type that accepts StageMethodSettingArray and StageMethodSettingArrayOutput values. You can construct a concrete instance of `StageMethodSettingArrayInput` via: 

StageMethodSettingArray{ StageMethodSettingArgs{...} }

type StageMethodSettingArrayOutput 

type StageMethodSettingArrayOutput struct{ *pulumi.OutputState }

func (StageMethodSettingArrayOutput) ElementType 

func (StageMethodSettingArrayOutput) ElementType() reflect.Type

func (StageMethodSettingArrayOutput) Index 

func (o StageMethodSettingArrayOutput) Index(i pulumi.IntInput) StageMethodSettingOutput

func (StageMethodSettingArrayOutput) ToStageMethodSettingArrayOutput 

func (o StageMethodSettingArrayOutput) ToStageMethodSettingArrayOutput() StageMethodSettingArrayOutput

func (StageMethodSettingArrayOutput) ToStageMethodSettingArrayOutputWithContext 

func (o StageMethodSettingArrayOutput) ToStageMethodSettingArrayOutputWithContext(ctx context.Context) StageMethodSettingArrayOutput

type StageMethodSettingInput 

type StageMethodSettingInput interface {
	pulumi.Input

	ToStageMethodSettingOutput() StageMethodSettingOutput
	ToStageMethodSettingOutputWithContext(context.Context) StageMethodSettingOutput
}

StageMethodSettingInput is an input type that accepts StageMethodSettingArgs and StageMethodSettingOutput values. You can construct a concrete instance of `StageMethodSettingInput` via: 

StageMethodSettingArgs{...}

type StageMethodSettingOutput 

type StageMethodSettingOutput struct{ *pulumi.OutputState }

The “MethodSetting“ property type configures settings for all methods in a stage. 

The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types.

func (StageMethodSettingOutput) CacheDataEncrypted 

func (o StageMethodSettingOutput) CacheDataEncrypted() pulumi.BoolPtrOutput

Specifies whether the cached responses are encrypted.

func (StageMethodSettingOutput) CacheTtlInSeconds 

func (o StageMethodSettingOutput) 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 (StageMethodSettingOutput) CachingEnabled 

func (o StageMethodSettingOutput) 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 (StageMethodSettingOutput) DataTraceEnabled 

func (o StageMethodSettingOutput) DataTraceEnabled() pulumi.BoolPtrOutput

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.

func (StageMethodSettingOutput) ElementType 

func (StageMethodSettingOutput) ElementType() reflect.Type

func (StageMethodSettingOutput) HttpMethod 

func (o StageMethodSettingOutput) HttpMethod() pulumi.StringPtrOutput

The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (“*“) for the “HttpMethod“ and “/*“ for the “ResourcePath“. This parameter is required when you specify a “MethodSetting“.

func (StageMethodSettingOutput) LoggingLevel 

func (o StageMethodSettingOutput) LoggingLevel() pulumi.StringPtrOutput

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are “OFF“, “ERROR“, and “INFO“. Choose “ERROR“ to write only error-level entries to CloudWatch Logs, or choose “INFO“ to include all “ERROR“ events as well as extra informational events.

func (StageMethodSettingOutput) MetricsEnabled 

func (o StageMethodSettingOutput) MetricsEnabled() pulumi.BoolPtrOutput

Specifies whether Amazon CloudWatch metrics are enabled for this method.

func (StageMethodSettingOutput) ResourcePath 

func (o StageMethodSettingOutput) ResourcePath() pulumi.StringPtrOutput

The resource path for this method. Forward slashes (“/“) are encoded as “~1“ and the initial slash must include a forward slash. For example, the path value “/resource/subresource“ must be encoded as “/~1resource~1subresource“. To specify the root path, use only a slash (“/“). To apply settings to multiple resources and methods, specify an asterisk (“*“) for the “HttpMethod“ and “/*“ for the “ResourcePath“. This parameter is required when you specify a “MethodSetting“.

func (StageMethodSettingOutput) ThrottlingBurstLimit 

func (o StageMethodSettingOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

Specifies the throttling burst limit.

func (StageMethodSettingOutput) ThrottlingRateLimit 

func (o StageMethodSettingOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput

Specifies the throttling rate limit.

func (StageMethodSettingOutput) ToStageMethodSettingOutput 

func (o StageMethodSettingOutput) ToStageMethodSettingOutput() StageMethodSettingOutput

func (StageMethodSettingOutput) ToStageMethodSettingOutputWithContext 

func (o StageMethodSettingOutput) ToStageMethodSettingOutputWithContext(ctx context.Context) StageMethodSettingOutput

type StageOutput 

type StageOutput struct{ *pulumi.OutputState }

func (StageOutput) AccessLogSetting added in v0.17.0 

func (o StageOutput) AccessLogSetting() StageAccessLogSettingPtrOutput

Access log settings, including the access log format and access log destination ARN.

func (StageOutput) CacheClusterEnabled added in v0.17.0 

func (o StageOutput) CacheClusterEnabled() pulumi.BoolPtrOutput

Specifies whether a cache cluster is enabled for the stage.

func (StageOutput) CacheClusterSize added in v0.17.0 

func (o StageOutput) CacheClusterSize() pulumi.StringPtrOutput

The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).

func (StageOutput) CanarySetting added in v0.17.0 

func (o StageOutput) CanarySetting() StageCanarySettingPtrOutput

Settings for the canary deployment in this stage.

func (StageOutput) ClientCertificateId added in v0.17.0 

func (o StageOutput) ClientCertificateId() pulumi.StringPtrOutput

The identifier of a client certificate for an API stage.

func (StageOutput) DeploymentId added in v0.17.0 

func (o StageOutput) DeploymentId() pulumi.StringPtrOutput

The identifier of the Deployment that the stage points to.

func (StageOutput) Description added in v0.17.0 

func (o StageOutput) Description() pulumi.StringPtrOutput

The stage's description.

func (StageOutput) DocumentationVersion added in v0.17.0 

func (o StageOutput) DocumentationVersion() pulumi.StringPtrOutput

The version of the associated API documentation.

func (StageOutput) ElementType 

func (StageOutput) ElementType() reflect.Type

func (StageOutput) MethodSettings added in v0.17.0 

func (o StageOutput) MethodSettings() StageMethodSettingArrayOutput

A map that defines the method settings for a Stage resource. Keys (designated as “/{method_setting_key“ below) are method paths defined as “{resource_path}/{http_method}“ for an individual method override, or “/\*/\*“ for overriding all methods in the stage.

func (StageOutput) RestApiId added in v0.17.0 

func (o StageOutput) RestApiId() pulumi.StringOutput

The string identifier of the associated RestApi.

func (StageOutput) StageName added in v0.17.0 

func (o StageOutput) StageName() pulumi.StringPtrOutput

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

func (StageOutput) Tags added in v0.17.0 

func (o StageOutput) Tags() aws.TagArrayOutput

The collection of tags. Each tag element is associated with a given resource.

func (StageOutput) ToStageOutput 

func (o StageOutput) ToStageOutput() StageOutput

func (StageOutput) ToStageOutputWithContext 

func (o StageOutput) ToStageOutputWithContext(ctx context.Context) StageOutput

func (StageOutput) TracingEnabled added in v0.17.0 

func (o StageOutput) TracingEnabled() pulumi.BoolPtrOutput

Specifies whether active tracing with X-ray is enabled for the Stage.

func (StageOutput) Variables added in v0.17.0 

func (o StageOutput) Variables() pulumi.StringMapOutput

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: “[A-Za-z0-9-._~:/?#&=,]+“.

type StageState 

type StageState struct {
}

func (StageState) ElementType 

func (StageState) ElementType() reflect.Type

type StageTag 

type StageTag struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:.
	Key string `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.
	Value string `pulumi:"value"`
}

type UsagePlan 

type UsagePlan struct {
	pulumi.CustomResourceState

	// The associated API stages of a usage plan.
	ApiStages UsagePlanApiStageArrayOutput `pulumi:"apiStages"`
	AwsId     pulumi.StringOutput          `pulumi:"awsId"`
	// The description of a usage plan.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The target maximum number of permitted requests per a given unit time interval.
	Quota UsagePlanQuotaSettingsPtrOutput `pulumi:"quota"`
	// The collection of tags. Each tag element is associated with a given resource.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// A map containing method level throttling information for API stage in a usage plan.
	Throttle UsagePlanThrottleSettingsPtrOutput `pulumi:"throttle"`
	// The name of a usage plan.
	UsagePlanName pulumi.StringPtrOutput `pulumi:"usagePlanName"`
}

The “AWS::ApiGateway::UsagePlan“ resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*. 

In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.

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.

func (*UsagePlan) ElementType 

func (*UsagePlan) ElementType() reflect.Type

func (*UsagePlan) ToUsagePlanOutput 

func (i *UsagePlan) ToUsagePlanOutput() UsagePlanOutput

func (*UsagePlan) ToUsagePlanOutputWithContext 

func (i *UsagePlan) ToUsagePlanOutputWithContext(ctx context.Context) UsagePlanOutput

type UsagePlanApiStage 

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"`
	// Map containing method level throttling information for API stage in a usage plan.
	Throttle map[string]UsagePlanThrottleSettings `pulumi:"throttle"`
}

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

type UsagePlanApiStageArgs 

type UsagePlanApiStageArgs struct {
	// API Id of the associated API stage in a usage plan.
	ApiId pulumi.StringPtrInput `pulumi:"apiId"`
	// API stage name of the associated API stage in a usage plan.
	Stage pulumi.StringPtrInput `pulumi:"stage"`
	// Map containing method level throttling information for API stage in a usage plan.
	Throttle UsagePlanThrottleSettingsMapInput `pulumi:"throttle"`
}

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

func (UsagePlanApiStageArgs) ElementType 

func (UsagePlanApiStageArgs) ElementType() reflect.Type

func (UsagePlanApiStageArgs) ToUsagePlanApiStageOutput 

func (i UsagePlanApiStageArgs) ToUsagePlanApiStageOutput() UsagePlanApiStageOutput

func (UsagePlanApiStageArgs) ToUsagePlanApiStageOutputWithContext 

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

type UsagePlanApiStageArray 

type UsagePlanApiStageArray []UsagePlanApiStageInput

func (UsagePlanApiStageArray) ElementType 

func (UsagePlanApiStageArray) ElementType() reflect.Type

func (UsagePlanApiStageArray) ToUsagePlanApiStageArrayOutput 

func (i UsagePlanApiStageArray) ToUsagePlanApiStageArrayOutput() UsagePlanApiStageArrayOutput

func (UsagePlanApiStageArray) ToUsagePlanApiStageArrayOutputWithContext 

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

type UsagePlanApiStageArrayInput 

type UsagePlanApiStageArrayInput interface {
	pulumi.Input

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

UsagePlanApiStageArrayInput is an input type that accepts UsagePlanApiStageArray and UsagePlanApiStageArrayOutput values. You can construct a concrete instance of `UsagePlanApiStageArrayInput` via: 

UsagePlanApiStageArray{ UsagePlanApiStageArgs{...} }

type UsagePlanApiStageArrayOutput 

type UsagePlanApiStageArrayOutput struct{ *pulumi.OutputState }

func (UsagePlanApiStageArrayOutput) ElementType 

func (UsagePlanApiStageArrayOutput) ElementType() reflect.Type

func (UsagePlanApiStageArrayOutput) Index 

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

func (UsagePlanApiStageArrayOutput) ToUsagePlanApiStageArrayOutput 

func (o UsagePlanApiStageArrayOutput) ToUsagePlanApiStageArrayOutput() UsagePlanApiStageArrayOutput

func (UsagePlanApiStageArrayOutput) ToUsagePlanApiStageArrayOutputWithContext 

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

type UsagePlanApiStageInput 

type UsagePlanApiStageInput interface {
	pulumi.Input

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

UsagePlanApiStageInput is an input type that accepts UsagePlanApiStageArgs and UsagePlanApiStageOutput values. You can construct a concrete instance of `UsagePlanApiStageInput` via: 

UsagePlanApiStageArgs{...}

type UsagePlanApiStageOutput 

type UsagePlanApiStageOutput struct{ *pulumi.OutputState }

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

func (UsagePlanApiStageOutput) ApiId 

func (o UsagePlanApiStageOutput) ApiId() pulumi.StringPtrOutput

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

func (UsagePlanApiStageOutput) ElementType 

func (UsagePlanApiStageOutput) ElementType() reflect.Type

func (UsagePlanApiStageOutput) Stage 

func (o UsagePlanApiStageOutput) Stage() pulumi.StringPtrOutput

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

func (UsagePlanApiStageOutput) Throttle 

func (o UsagePlanApiStageOutput) Throttle() UsagePlanThrottleSettingsMapOutput

Map containing method level throttling information for API stage in a usage plan.

func (UsagePlanApiStageOutput) ToUsagePlanApiStageOutput 

func (o UsagePlanApiStageOutput) ToUsagePlanApiStageOutput() UsagePlanApiStageOutput

func (UsagePlanApiStageOutput) ToUsagePlanApiStageOutputWithContext 

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

type UsagePlanArgs 

type UsagePlanArgs struct {
	// The associated API stages of a usage plan.
	ApiStages UsagePlanApiStageArrayInput
	// The description of a usage plan.
	Description pulumi.StringPtrInput
	// The target maximum number of permitted requests per a given unit time interval.
	Quota UsagePlanQuotaSettingsPtrInput
	// The collection of tags. Each tag element is associated with a given resource.
	Tags aws.TagArrayInput
	// A map containing method level throttling information for API stage in a usage plan.
	Throttle UsagePlanThrottleSettingsPtrInput
	// The name of a usage plan.
	UsagePlanName pulumi.StringPtrInput
}

The set of arguments for constructing a UsagePlan resource.

func (UsagePlanArgs) ElementType 

func (UsagePlanArgs) ElementType() reflect.Type

type UsagePlanInput 

type UsagePlanInput interface {
	pulumi.Input

	ToUsagePlanOutput() UsagePlanOutput
	ToUsagePlanOutputWithContext(ctx context.Context) UsagePlanOutput
}

type UsagePlanKey 

type UsagePlanKey struct {
	pulumi.CustomResourceState

	AwsId pulumi.StringOutput `pulumi:"awsId"`
	// The Id of the UsagePlanKey resource.
	KeyId pulumi.StringOutput `pulumi:"keyId"`
	// The type of a UsagePlanKey resource for a plan customer.
	KeyType UsagePlanKeyKeyTypeOutput `pulumi:"keyType"`
	// The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
	UsagePlanId pulumi.StringOutput `pulumi:"usagePlanId"`
}

The “AWS::ApiGateway::UsagePlanKey“ resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.

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.

func (*UsagePlanKey) ElementType 

func (*UsagePlanKey) ElementType() reflect.Type

func (*UsagePlanKey) ToUsagePlanKeyOutput 

func (i *UsagePlanKey) ToUsagePlanKeyOutput() UsagePlanKeyOutput

func (*UsagePlanKey) ToUsagePlanKeyOutputWithContext 

func (i *UsagePlanKey) ToUsagePlanKeyOutputWithContext(ctx context.Context) UsagePlanKeyOutput

type UsagePlanKeyArgs 

type UsagePlanKeyArgs struct {
	// The Id of the UsagePlanKey resource.
	KeyId pulumi.StringInput
	// The type of a UsagePlanKey resource for a plan customer.
	KeyType UsagePlanKeyKeyTypeInput
	// The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
	UsagePlanId pulumi.StringInput
}

The set of arguments for constructing a UsagePlanKey resource.

func (UsagePlanKeyArgs) ElementType 

func (UsagePlanKeyArgs) ElementType() reflect.Type

type UsagePlanKeyInput 

type UsagePlanKeyInput interface {
	pulumi.Input

	ToUsagePlanKeyOutput() UsagePlanKeyOutput
	ToUsagePlanKeyOutputWithContext(ctx context.Context) UsagePlanKeyOutput
}

type UsagePlanKeyKeyType 

type UsagePlanKeyKeyType string

The type of a UsagePlanKey resource for a plan customer.

func (UsagePlanKeyKeyType) ElementType 

func (UsagePlanKeyKeyType) ElementType() reflect.Type

func (UsagePlanKeyKeyType) ToStringOutput 

func (e UsagePlanKeyKeyType) ToStringOutput() pulumi.StringOutput

func (UsagePlanKeyKeyType) ToStringOutputWithContext 

func (e UsagePlanKeyKeyType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (UsagePlanKeyKeyType) ToStringPtrOutput 

func (e UsagePlanKeyKeyType) ToStringPtrOutput() pulumi.StringPtrOutput

func (UsagePlanKeyKeyType) ToStringPtrOutputWithContext 

func (e UsagePlanKeyKeyType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (UsagePlanKeyKeyType) ToUsagePlanKeyKeyTypeOutput 

func (e UsagePlanKeyKeyType) ToUsagePlanKeyKeyTypeOutput() UsagePlanKeyKeyTypeOutput

func (UsagePlanKeyKeyType) ToUsagePlanKeyKeyTypeOutputWithContext 

func (e UsagePlanKeyKeyType) ToUsagePlanKeyKeyTypeOutputWithContext(ctx context.Context) UsagePlanKeyKeyTypeOutput

func (UsagePlanKeyKeyType) ToUsagePlanKeyKeyTypePtrOutput 

func (e UsagePlanKeyKeyType) ToUsagePlanKeyKeyTypePtrOutput() UsagePlanKeyKeyTypePtrOutput

func (UsagePlanKeyKeyType) ToUsagePlanKeyKeyTypePtrOutputWithContext 

func (e UsagePlanKeyKeyType) ToUsagePlanKeyKeyTypePtrOutputWithContext(ctx context.Context) UsagePlanKeyKeyTypePtrOutput

type UsagePlanKeyKeyTypeInput 

type UsagePlanKeyKeyTypeInput interface {
	pulumi.Input

	ToUsagePlanKeyKeyTypeOutput() UsagePlanKeyKeyTypeOutput
	ToUsagePlanKeyKeyTypeOutputWithContext(context.Context) UsagePlanKeyKeyTypeOutput
}

UsagePlanKeyKeyTypeInput is an input type that accepts values of the UsagePlanKeyKeyType enum A concrete instance of `UsagePlanKeyKeyTypeInput` can be one of the following: 

UsagePlanKeyKeyTypeApiKey

type UsagePlanKeyKeyTypeOutput 

type UsagePlanKeyKeyTypeOutput struct{ *pulumi.OutputState }

func (UsagePlanKeyKeyTypeOutput) ElementType 

func (UsagePlanKeyKeyTypeOutput) ElementType() reflect.Type

func (UsagePlanKeyKeyTypeOutput) ToStringOutput 

func (o UsagePlanKeyKeyTypeOutput) ToStringOutput() pulumi.StringOutput

func (UsagePlanKeyKeyTypeOutput) ToStringOutputWithContext 

func (o UsagePlanKeyKeyTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (UsagePlanKeyKeyTypeOutput) ToStringPtrOutput 

func (o UsagePlanKeyKeyTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (UsagePlanKeyKeyTypeOutput) ToStringPtrOutputWithContext 

func (o UsagePlanKeyKeyTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (UsagePlanKeyKeyTypeOutput) ToUsagePlanKeyKeyTypeOutput 

func (o UsagePlanKeyKeyTypeOutput) ToUsagePlanKeyKeyTypeOutput() UsagePlanKeyKeyTypeOutput

func (UsagePlanKeyKeyTypeOutput) ToUsagePlanKeyKeyTypeOutputWithContext 

func (o UsagePlanKeyKeyTypeOutput) ToUsagePlanKeyKeyTypeOutputWithContext(ctx context.Context) UsagePlanKeyKeyTypeOutput

func (UsagePlanKeyKeyTypeOutput) ToUsagePlanKeyKeyTypePtrOutput 

func (o UsagePlanKeyKeyTypeOutput) ToUsagePlanKeyKeyTypePtrOutput() UsagePlanKeyKeyTypePtrOutput

func (UsagePlanKeyKeyTypeOutput) ToUsagePlanKeyKeyTypePtrOutputWithContext 

func (o UsagePlanKeyKeyTypeOutput) ToUsagePlanKeyKeyTypePtrOutputWithContext(ctx context.Context) UsagePlanKeyKeyTypePtrOutput

type UsagePlanKeyKeyTypePtrInput 

type UsagePlanKeyKeyTypePtrInput interface {
	pulumi.Input

	ToUsagePlanKeyKeyTypePtrOutput() UsagePlanKeyKeyTypePtrOutput
	ToUsagePlanKeyKeyTypePtrOutputWithContext(context.Context) UsagePlanKeyKeyTypePtrOutput
}

func UsagePlanKeyKeyTypePtr 

func UsagePlanKeyKeyTypePtr(v string) UsagePlanKeyKeyTypePtrInput

type UsagePlanKeyKeyTypePtrOutput 

type UsagePlanKeyKeyTypePtrOutput struct{ *pulumi.OutputState }

func (UsagePlanKeyKeyTypePtrOutput) Elem 

func (o UsagePlanKeyKeyTypePtrOutput) Elem() UsagePlanKeyKeyTypeOutput

func (UsagePlanKeyKeyTypePtrOutput) ElementType 

func (UsagePlanKeyKeyTypePtrOutput) ElementType() reflect.Type

func (UsagePlanKeyKeyTypePtrOutput) ToStringPtrOutput 

func (o UsagePlanKeyKeyTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (UsagePlanKeyKeyTypePtrOutput) ToStringPtrOutputWithContext 

func (o UsagePlanKeyKeyTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (UsagePlanKeyKeyTypePtrOutput) ToUsagePlanKeyKeyTypePtrOutput 

func (o UsagePlanKeyKeyTypePtrOutput) ToUsagePlanKeyKeyTypePtrOutput() UsagePlanKeyKeyTypePtrOutput

func (UsagePlanKeyKeyTypePtrOutput) ToUsagePlanKeyKeyTypePtrOutputWithContext 

func (o UsagePlanKeyKeyTypePtrOutput) ToUsagePlanKeyKeyTypePtrOutputWithContext(ctx context.Context) UsagePlanKeyKeyTypePtrOutput

type UsagePlanKeyOutput 

type UsagePlanKeyOutput struct{ *pulumi.OutputState }

func (UsagePlanKeyOutput) AwsId added in v0.99.0 

func (o UsagePlanKeyOutput) AwsId() pulumi.StringOutput

func (UsagePlanKeyOutput) ElementType 

func (UsagePlanKeyOutput) ElementType() reflect.Type

func (UsagePlanKeyOutput) KeyId added in v0.17.0 

func (o UsagePlanKeyOutput) KeyId() pulumi.StringOutput

The Id of the UsagePlanKey resource.

func (UsagePlanKeyOutput) KeyType added in v0.17.0 

func (o UsagePlanKeyOutput) KeyType() UsagePlanKeyKeyTypeOutput

The type of a UsagePlanKey resource for a plan customer.

func (UsagePlanKeyOutput) ToUsagePlanKeyOutput 

func (o UsagePlanKeyOutput) ToUsagePlanKeyOutput() UsagePlanKeyOutput

func (UsagePlanKeyOutput) ToUsagePlanKeyOutputWithContext 

func (o UsagePlanKeyOutput) ToUsagePlanKeyOutputWithContext(ctx context.Context) UsagePlanKeyOutput

func (UsagePlanKeyOutput) UsagePlanId added in v0.17.0 

func (o UsagePlanKeyOutput) UsagePlanId() pulumi.StringOutput

The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.

type UsagePlanKeyState 

type UsagePlanKeyState struct {
}

func (UsagePlanKeyState) ElementType 

func (UsagePlanKeyState) ElementType() reflect.Type

type UsagePlanOutput 

type UsagePlanOutput struct{ *pulumi.OutputState }

func (UsagePlanOutput) ApiStages added in v0.17.0 

func (o UsagePlanOutput) ApiStages() UsagePlanApiStageArrayOutput

The associated API stages of a usage plan.

func (UsagePlanOutput) AwsId added in v0.99.0 

func (o UsagePlanOutput) AwsId() pulumi.StringOutput

func (UsagePlanOutput) Description added in v0.17.0 

func (o UsagePlanOutput) Description() pulumi.StringPtrOutput

The description of a usage plan.

func (UsagePlanOutput) ElementType 

func (UsagePlanOutput) ElementType() reflect.Type

func (UsagePlanOutput) Quota added in v0.17.0 

func (o UsagePlanOutput) Quota() UsagePlanQuotaSettingsPtrOutput

The target maximum number of permitted requests per a given unit time interval.

func (UsagePlanOutput) Tags added in v0.17.0 

func (o UsagePlanOutput) Tags() aws.TagArrayOutput

The collection of tags. Each tag element is associated with a given resource.

func (UsagePlanOutput) Throttle added in v0.17.0 

func (o UsagePlanOutput) Throttle() UsagePlanThrottleSettingsPtrOutput

A map containing method level throttling information for API stage in a usage plan.

func (UsagePlanOutput) ToUsagePlanOutput 

func (o UsagePlanOutput) ToUsagePlanOutput() UsagePlanOutput

func (UsagePlanOutput) ToUsagePlanOutputWithContext 

func (o UsagePlanOutput) ToUsagePlanOutputWithContext(ctx context.Context) UsagePlanOutput

func (UsagePlanOutput) UsagePlanName added in v0.17.0 

func (o UsagePlanOutput) UsagePlanName() pulumi.StringPtrOutput

The name of a usage plan.

type UsagePlanQuotaSettings 

type UsagePlanQuotaSettings struct {
	// The target 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"`
}

“QuotaSettings“ is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs. 

In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.

type UsagePlanQuotaSettingsArgs 

type UsagePlanQuotaSettingsArgs struct {
	// The target maximum number of requests that can be made in a given time period.
	Limit pulumi.IntPtrInput `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.StringPtrInput `pulumi:"period"`
}

“QuotaSettings“ is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs. 

In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.

func (UsagePlanQuotaSettingsArgs) ElementType 

func (UsagePlanQuotaSettingsArgs) ElementType() reflect.Type

func (UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsOutput 

func (i UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsOutput() UsagePlanQuotaSettingsOutput

func (UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsOutputWithContext 

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

func (UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsPtrOutput 

func (i UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsPtrOutput() UsagePlanQuotaSettingsPtrOutput

func (UsagePlanQuotaSettingsArgs) ToUsagePlanQuotaSettingsPtrOutputWithContext 

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

type UsagePlanQuotaSettingsInput 

type UsagePlanQuotaSettingsInput interface {
	pulumi.Input

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

UsagePlanQuotaSettingsInput is an input type that accepts UsagePlanQuotaSettingsArgs and UsagePlanQuotaSettingsOutput values. You can construct a concrete instance of `UsagePlanQuotaSettingsInput` via: 

UsagePlanQuotaSettingsArgs{...}

type UsagePlanQuotaSettingsOutput 

type UsagePlanQuotaSettingsOutput struct{ *pulumi.OutputState }

“QuotaSettings“ is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs. 

In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.

func (UsagePlanQuotaSettingsOutput) ElementType 

func (UsagePlanQuotaSettingsOutput) ElementType() reflect.Type

func (UsagePlanQuotaSettingsOutput) Limit 

func (o UsagePlanQuotaSettingsOutput) Limit() pulumi.IntPtrOutput

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

func (UsagePlanQuotaSettingsOutput) Offset 

func (o UsagePlanQuotaSettingsOutput) Offset() pulumi.IntPtrOutput

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

func (UsagePlanQuotaSettingsOutput) Period 

func (o UsagePlanQuotaSettingsOutput) Period() pulumi.StringPtrOutput

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

func (UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsOutput 

func (o UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsOutput() UsagePlanQuotaSettingsOutput

func (UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsOutputWithContext 

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

func (UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsPtrOutput 

func (o UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsPtrOutput() UsagePlanQuotaSettingsPtrOutput

func (UsagePlanQuotaSettingsOutput) ToUsagePlanQuotaSettingsPtrOutputWithContext 

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

type UsagePlanQuotaSettingsPtrInput 

type UsagePlanQuotaSettingsPtrInput interface {
	pulumi.Input

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

UsagePlanQuotaSettingsPtrInput is an input type that accepts UsagePlanQuotaSettingsArgs, UsagePlanQuotaSettingsPtr and UsagePlanQuotaSettingsPtrOutput values. You can construct a concrete instance of `UsagePlanQuotaSettingsPtrInput` via: 

        UsagePlanQuotaSettingsArgs{...}

or:

        nil

func UsagePlanQuotaSettingsPtr 

func UsagePlanQuotaSettingsPtr(v *UsagePlanQuotaSettingsArgs) UsagePlanQuotaSettingsPtrInput

type UsagePlanQuotaSettingsPtrOutput 

type UsagePlanQuotaSettingsPtrOutput struct{ *pulumi.OutputState }

func (UsagePlanQuotaSettingsPtrOutput) Elem 

func (o UsagePlanQuotaSettingsPtrOutput) Elem() UsagePlanQuotaSettingsOutput

func (UsagePlanQuotaSettingsPtrOutput) ElementType 

func (UsagePlanQuotaSettingsPtrOutput) ElementType() reflect.Type

func (UsagePlanQuotaSettingsPtrOutput) Limit 

func (o UsagePlanQuotaSettingsPtrOutput) Limit() pulumi.IntPtrOutput

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

func (UsagePlanQuotaSettingsPtrOutput) Offset 

func (o UsagePlanQuotaSettingsPtrOutput) Offset() pulumi.IntPtrOutput

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

func (UsagePlanQuotaSettingsPtrOutput) Period 

func (o UsagePlanQuotaSettingsPtrOutput) Period() pulumi.StringPtrOutput

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

func (UsagePlanQuotaSettingsPtrOutput) ToUsagePlanQuotaSettingsPtrOutput 

func (o UsagePlanQuotaSettingsPtrOutput) ToUsagePlanQuotaSettingsPtrOutput() UsagePlanQuotaSettingsPtrOutput

func (UsagePlanQuotaSettingsPtrOutput) ToUsagePlanQuotaSettingsPtrOutputWithContext 

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

type UsagePlanState 

type UsagePlanState struct {
}

func (UsagePlanState) ElementType 

func (UsagePlanState) ElementType() reflect.Type

type UsagePlanTag 

type UsagePlanTag struct {
	// The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key string `pulumi:"key"`
	// The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value string `pulumi:"value"`
}

type UsagePlanThrottleSettings 

type UsagePlanThrottleSettings struct {
	// The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
	BurstLimit *int `pulumi:"burstLimit"`
	// The API target request rate limit.
	RateLimit *float64 `pulumi:"rateLimit"`
}

“ThrottleSettings“ is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.

type UsagePlanThrottleSettingsArgs 

type UsagePlanThrottleSettingsArgs struct {
	// The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
	BurstLimit pulumi.IntPtrInput `pulumi:"burstLimit"`
	// The API target request rate limit.
	RateLimit pulumi.Float64PtrInput `pulumi:"rateLimit"`
}

“ThrottleSettings“ is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.

func (UsagePlanThrottleSettingsArgs) ElementType 

func (UsagePlanThrottleSettingsArgs) ElementType() reflect.Type

func (UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsOutput 

func (i UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsOutput() UsagePlanThrottleSettingsOutput

func (UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsOutputWithContext 

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

func (UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsPtrOutput 

func (i UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsPtrOutput() UsagePlanThrottleSettingsPtrOutput

func (UsagePlanThrottleSettingsArgs) ToUsagePlanThrottleSettingsPtrOutputWithContext 

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

type UsagePlanThrottleSettingsInput 

type UsagePlanThrottleSettingsInput interface {
	pulumi.Input

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

UsagePlanThrottleSettingsInput is an input type that accepts UsagePlanThrottleSettingsArgs and UsagePlanThrottleSettingsOutput values. You can construct a concrete instance of `UsagePlanThrottleSettingsInput` via: 

UsagePlanThrottleSettingsArgs{...}

type UsagePlanThrottleSettingsMap added in v0.97.0 

type UsagePlanThrottleSettingsMap map[string]UsagePlanThrottleSettingsInput

func (UsagePlanThrottleSettingsMap) ElementType added in v0.97.0 

func (UsagePlanThrottleSettingsMap) ElementType() reflect.Type

func (UsagePlanThrottleSettingsMap) ToUsagePlanThrottleSettingsMapOutput added in v0.97.0 

func (i UsagePlanThrottleSettingsMap) ToUsagePlanThrottleSettingsMapOutput() UsagePlanThrottleSettingsMapOutput

func (UsagePlanThrottleSettingsMap) ToUsagePlanThrottleSettingsMapOutputWithContext added in v0.97.0 

func (i UsagePlanThrottleSettingsMap) ToUsagePlanThrottleSettingsMapOutputWithContext(ctx context.Context) UsagePlanThrottleSettingsMapOutput

type UsagePlanThrottleSettingsMapInput added in v0.97.0 

type UsagePlanThrottleSettingsMapInput interface {
	pulumi.Input

	ToUsagePlanThrottleSettingsMapOutput() UsagePlanThrottleSettingsMapOutput
	ToUsagePlanThrottleSettingsMapOutputWithContext(context.Context) UsagePlanThrottleSettingsMapOutput
}

UsagePlanThrottleSettingsMapInput is an input type that accepts UsagePlanThrottleSettingsMap and UsagePlanThrottleSettingsMapOutput values. You can construct a concrete instance of `UsagePlanThrottleSettingsMapInput` via: 

UsagePlanThrottleSettingsMap{ "key": UsagePlanThrottleSettingsArgs{...} }

type UsagePlanThrottleSettingsMapOutput added in v0.97.0 

type UsagePlanThrottleSettingsMapOutput struct{ *pulumi.OutputState }

func (UsagePlanThrottleSettingsMapOutput) ElementType added in v0.97.0 

func (UsagePlanThrottleSettingsMapOutput) ElementType() reflect.Type

func (UsagePlanThrottleSettingsMapOutput) MapIndex added in v0.97.0 

func (o UsagePlanThrottleSettingsMapOutput) MapIndex(k pulumi.StringInput) UsagePlanThrottleSettingsOutput

func (UsagePlanThrottleSettingsMapOutput) ToUsagePlanThrottleSettingsMapOutput added in v0.97.0 

func (o UsagePlanThrottleSettingsMapOutput) ToUsagePlanThrottleSettingsMapOutput() UsagePlanThrottleSettingsMapOutput

func (UsagePlanThrottleSettingsMapOutput) ToUsagePlanThrottleSettingsMapOutputWithContext added in v0.97.0 

func (o UsagePlanThrottleSettingsMapOutput) ToUsagePlanThrottleSettingsMapOutputWithContext(ctx context.Context) UsagePlanThrottleSettingsMapOutput

type UsagePlanThrottleSettingsOutput 

type UsagePlanThrottleSettingsOutput struct{ *pulumi.OutputState }

“ThrottleSettings“ is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.

func (UsagePlanThrottleSettingsOutput) BurstLimit 

func (o UsagePlanThrottleSettingsOutput) BurstLimit() pulumi.IntPtrOutput

The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

func (UsagePlanThrottleSettingsOutput) ElementType 

func (UsagePlanThrottleSettingsOutput) ElementType() reflect.Type

func (UsagePlanThrottleSettingsOutput) RateLimit 

func (o UsagePlanThrottleSettingsOutput) RateLimit() pulumi.Float64PtrOutput

The API target request rate limit.

func (UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsOutput 

func (o UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsOutput() UsagePlanThrottleSettingsOutput

func (UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsOutputWithContext 

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

func (UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsPtrOutput 

func (o UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsPtrOutput() UsagePlanThrottleSettingsPtrOutput

func (UsagePlanThrottleSettingsOutput) ToUsagePlanThrottleSettingsPtrOutputWithContext 

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

type UsagePlanThrottleSettingsPtrInput 

type UsagePlanThrottleSettingsPtrInput interface {
	pulumi.Input

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

UsagePlanThrottleSettingsPtrInput is an input type that accepts UsagePlanThrottleSettingsArgs, UsagePlanThrottleSettingsPtr and UsagePlanThrottleSettingsPtrOutput values. You can construct a concrete instance of `UsagePlanThrottleSettingsPtrInput` via: 

        UsagePlanThrottleSettingsArgs{...}

or:

        nil

func UsagePlanThrottleSettingsPtr 

func UsagePlanThrottleSettingsPtr(v *UsagePlanThrottleSettingsArgs) UsagePlanThrottleSettingsPtrInput

type UsagePlanThrottleSettingsPtrOutput 

type UsagePlanThrottleSettingsPtrOutput struct{ *pulumi.OutputState }

func (UsagePlanThrottleSettingsPtrOutput) BurstLimit 

func (o UsagePlanThrottleSettingsPtrOutput) BurstLimit() pulumi.IntPtrOutput

The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

func (UsagePlanThrottleSettingsPtrOutput) Elem 

func (o UsagePlanThrottleSettingsPtrOutput) Elem() UsagePlanThrottleSettingsOutput

func (UsagePlanThrottleSettingsPtrOutput) ElementType 

func (UsagePlanThrottleSettingsPtrOutput) ElementType() reflect.Type

func (UsagePlanThrottleSettingsPtrOutput) RateLimit 

func (o UsagePlanThrottleSettingsPtrOutput) RateLimit() pulumi.Float64PtrOutput

The API target request rate limit.

func (UsagePlanThrottleSettingsPtrOutput) ToUsagePlanThrottleSettingsPtrOutput 

func (o UsagePlanThrottleSettingsPtrOutput) ToUsagePlanThrottleSettingsPtrOutput() UsagePlanThrottleSettingsPtrOutput

func (UsagePlanThrottleSettingsPtrOutput) ToUsagePlanThrottleSettingsPtrOutputWithContext 

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

	// A description of the VPC link.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// A name for the VPC link.
	Name pulumi.StringOutput `pulumi:"name"`
	// An array of arbitrary tags (key-value pairs) to associate with the stage.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
	TargetArns pulumi.StringArrayOutput `pulumi:"targetArns"`
	// The ID of the instance that backs VPC link.
	VpcLinkId pulumi.StringOutput `pulumi:"vpcLinkId"`
}

Schema for AWS ApiGateway VpcLink 

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.

func (*VpcLink) ElementType 

func (*VpcLink) ElementType() reflect.Type

func (*VpcLink) ToVpcLinkOutput 

func (i *VpcLink) ToVpcLinkOutput() VpcLinkOutput

func (*VpcLink) ToVpcLinkOutputWithContext 

func (i *VpcLink) ToVpcLinkOutputWithContext(ctx context.Context) VpcLinkOutput

type VpcLinkArgs 

type VpcLinkArgs struct {
	// A description of the VPC link.
	Description pulumi.StringPtrInput
	// A name for the VPC link.
	Name pulumi.StringPtrInput
	// An array of arbitrary tags (key-value pairs) to associate with the stage.
	Tags aws.TagArrayInput
	// The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
	TargetArns pulumi.StringArrayInput
}

The set of arguments for constructing a VpcLink resource.

func (VpcLinkArgs) ElementType 

func (VpcLinkArgs) ElementType() reflect.Type

type VpcLinkInput 

type VpcLinkInput interface {
	pulumi.Input

	ToVpcLinkOutput() VpcLinkOutput
	ToVpcLinkOutputWithContext(ctx context.Context) VpcLinkOutput
}

type VpcLinkOutput 

type VpcLinkOutput struct{ *pulumi.OutputState }

func (VpcLinkOutput) Description added in v0.17.0 

func (o VpcLinkOutput) Description() pulumi.StringPtrOutput

A description of the VPC link.

func (VpcLinkOutput) ElementType 

func (VpcLinkOutput) ElementType() reflect.Type

func (VpcLinkOutput) Name added in v0.17.0 

func (o VpcLinkOutput) Name() pulumi.StringOutput

A name for the VPC link.

func (VpcLinkOutput) Tags added in v0.17.0 

func (o VpcLinkOutput) Tags() aws.TagArrayOutput

An array of arbitrary tags (key-value pairs) to associate with the stage.

func (VpcLinkOutput) TargetArns added in v0.17.0 

func (o VpcLinkOutput) TargetArns() pulumi.StringArrayOutput

The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

func (VpcLinkOutput) ToVpcLinkOutput 

func (o VpcLinkOutput) ToVpcLinkOutput() VpcLinkOutput

func (VpcLinkOutput) ToVpcLinkOutputWithContext 

func (o VpcLinkOutput) ToVpcLinkOutputWithContext(ctx context.Context) VpcLinkOutput

func (VpcLinkOutput) VpcLinkId added in v0.52.0 

func (o VpcLinkOutput) VpcLinkId() pulumi.StringOutput

The ID of the instance that backs VPC link.

type VpcLinkState 

type VpcLinkState struct {
}

func (VpcLinkState) ElementType 

func (VpcLinkState) ElementType() reflect.Type

type VpcLinkTag added in v0.3.0 

type VpcLinkTag struct {
	Key   string `pulumi:"key"`
	Value string `pulumi:"value"`
}

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.