apigateway

package
v0.76.0 Latest Latest
Warning

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

Go to latest
Published: Sep 13, 2023 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

	// The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.
	CloudWatchRoleArn pulumi.StringPtrOutput `pulumi:"cloudWatchRoleArn"`
}

Resource Type definition for AWS::ApiGateway::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

func (*Account) ToOutput added in v0.76.0

func (i *Account) ToOutput(ctx context.Context) pulumix.Output[*Account]

type AccountArgs

type AccountArgs struct {
	// The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your 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) CloudWatchRoleArn added in v0.17.0

func (o AccountOutput) CloudWatchRoleArn() pulumi.StringPtrOutput

The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your 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

func (AccountOutput) ToOutput added in v0.76.0

func (o AccountOutput) ToOutput(ctx context.Context) pulumix.Output[*Account]

type AccountState

type AccountState struct {
}

func (AccountState) ElementType

func (AccountState) ElementType() reflect.Type

type ApiKey

type ApiKey struct {
	pulumi.CustomResourceState

	// A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
	ApiKeyId pulumi.StringOutput `pulumi:"apiKeyId"`
	// An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
	CustomerId pulumi.StringPtrOutput `pulumi:"customerId"`
	// A description of the purpose of the API key.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Indicates whether the API key can be used by clients.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	// Specifies whether 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, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// A list of stages to associate with this API key.
	StageKeys ApiKeyStageKeyArrayOutput `pulumi:"stageKeys"`
	// An array of arbitrary tags (key-value pairs) to associate with the API key.
	Tags ApiKeyTagArrayOutput `pulumi:"tags"`
	// The value of the API key. Must be at least 20 characters long.
	Value pulumi.StringPtrOutput `pulumi:"value"`
}

Resource Type definition for AWS::ApiGateway::ApiKey

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

func (*ApiKey) ToOutput added in v0.76.0

func (i *ApiKey) ToOutput(ctx context.Context) pulumix.Output[*ApiKey]

type ApiKeyArgs

type ApiKeyArgs struct {
	// An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
	CustomerId pulumi.StringPtrInput
	// A description of the purpose of the API key.
	Description pulumi.StringPtrInput
	// Indicates whether the API key can be used by clients.
	Enabled pulumi.BoolPtrInput
	// Specifies whether 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, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
	Name pulumi.StringPtrInput
	// A list of stages to associate with this API key.
	StageKeys ApiKeyStageKeyArrayInput
	// An array of arbitrary tags (key-value pairs) to associate with the API key.
	Tags ApiKeyTagArrayInput
	// The value of the API key. Must be at least 20 characters long.
	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

A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

func (ApiKeyOutput) CustomerId added in v0.17.0

func (o ApiKeyOutput) CustomerId() pulumi.StringPtrOutput

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

func (ApiKeyOutput) Description added in v0.17.0

func (o ApiKeyOutput) Description() pulumi.StringPtrOutput

A description of the purpose of the API key.

func (ApiKeyOutput) ElementType

func (ApiKeyOutput) ElementType() reflect.Type

func (ApiKeyOutput) Enabled added in v0.17.0

func (o ApiKeyOutput) Enabled() pulumi.BoolPtrOutput

Indicates whether the API key can be used by clients.

func (ApiKeyOutput) GenerateDistinctId added in v0.17.0

func (o ApiKeyOutput) GenerateDistinctId() pulumi.BoolPtrOutput

Specifies whether 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

A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.

func (ApiKeyOutput) StageKeys added in v0.17.0

A list of stages to associate with this API key.

func (ApiKeyOutput) Tags added in v0.17.0

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

func (ApiKeyOutput) ToApiKeyOutput

func (o ApiKeyOutput) ToApiKeyOutput() ApiKeyOutput

func (ApiKeyOutput) ToApiKeyOutputWithContext

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

func (ApiKeyOutput) ToOutput added in v0.76.0

func (o ApiKeyOutput) ToOutput(ctx context.Context) pulumix.Output[*ApiKey]

func (ApiKeyOutput) Value added in v0.17.0

The value of the API key. Must be at least 20 characters long.

type ApiKeyStageKey

type ApiKeyStageKey struct {
	// The ID of a RestApi resource that includes the stage with which you want to associate the API key.
	RestApiId *string `pulumi:"restApiId"`
	// The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.
	StageName *string `pulumi:"stageName"`
}

type ApiKeyStageKeyArgs

type ApiKeyStageKeyArgs struct {
	// The ID of a RestApi resource that includes the stage with which you want to associate the API key.
	RestApiId pulumi.StringPtrInput `pulumi:"restApiId"`
	// The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.
	StageName pulumi.StringPtrInput `pulumi:"stageName"`
}

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

func (ApiKeyStageKeyArgs) ToOutput added in v0.76.0

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

func (ApiKeyStageKeyArray) ToOutput added in v0.76.0

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 (ApiKeyStageKeyArrayOutput) ToApiKeyStageKeyArrayOutput

func (o ApiKeyStageKeyArrayOutput) ToApiKeyStageKeyArrayOutput() ApiKeyStageKeyArrayOutput

func (ApiKeyStageKeyArrayOutput) ToApiKeyStageKeyArrayOutputWithContext

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

func (ApiKeyStageKeyArrayOutput) ToOutput added in v0.76.0

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 }

func (ApiKeyStageKeyOutput) ElementType

func (ApiKeyStageKeyOutput) ElementType() reflect.Type

func (ApiKeyStageKeyOutput) RestApiId

The ID of a RestApi resource that includes the stage with which you want to associate the API key.

func (ApiKeyStageKeyOutput) StageName

The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.

func (ApiKeyStageKeyOutput) ToApiKeyStageKeyOutput

func (o ApiKeyStageKeyOutput) ToApiKeyStageKeyOutput() ApiKeyStageKeyOutput

func (ApiKeyStageKeyOutput) ToApiKeyStageKeyOutputWithContext

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

func (ApiKeyStageKeyOutput) ToOutput added in v0.76.0

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 ApiKeyTagArgs

type ApiKeyTagArgs 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 pulumi.StringInput `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 pulumi.StringInput `pulumi:"value"`
}

func (ApiKeyTagArgs) ElementType

func (ApiKeyTagArgs) ElementType() reflect.Type

func (ApiKeyTagArgs) ToApiKeyTagOutput

func (i ApiKeyTagArgs) ToApiKeyTagOutput() ApiKeyTagOutput

func (ApiKeyTagArgs) ToApiKeyTagOutputWithContext

func (i ApiKeyTagArgs) ToApiKeyTagOutputWithContext(ctx context.Context) ApiKeyTagOutput

func (ApiKeyTagArgs) ToOutput added in v0.76.0

type ApiKeyTagArray

type ApiKeyTagArray []ApiKeyTagInput

func (ApiKeyTagArray) ElementType

func (ApiKeyTagArray) ElementType() reflect.Type

func (ApiKeyTagArray) ToApiKeyTagArrayOutput

func (i ApiKeyTagArray) ToApiKeyTagArrayOutput() ApiKeyTagArrayOutput

func (ApiKeyTagArray) ToApiKeyTagArrayOutputWithContext

func (i ApiKeyTagArray) ToApiKeyTagArrayOutputWithContext(ctx context.Context) ApiKeyTagArrayOutput

func (ApiKeyTagArray) ToOutput added in v0.76.0

type ApiKeyTagArrayInput

type ApiKeyTagArrayInput interface {
	pulumi.Input

	ToApiKeyTagArrayOutput() ApiKeyTagArrayOutput
	ToApiKeyTagArrayOutputWithContext(context.Context) ApiKeyTagArrayOutput
}

ApiKeyTagArrayInput is an input type that accepts ApiKeyTagArray and ApiKeyTagArrayOutput values. You can construct a concrete instance of `ApiKeyTagArrayInput` via:

ApiKeyTagArray{ ApiKeyTagArgs{...} }

type ApiKeyTagArrayOutput

type ApiKeyTagArrayOutput struct{ *pulumi.OutputState }

func (ApiKeyTagArrayOutput) ElementType

func (ApiKeyTagArrayOutput) ElementType() reflect.Type

func (ApiKeyTagArrayOutput) Index

func (ApiKeyTagArrayOutput) ToApiKeyTagArrayOutput

func (o ApiKeyTagArrayOutput) ToApiKeyTagArrayOutput() ApiKeyTagArrayOutput

func (ApiKeyTagArrayOutput) ToApiKeyTagArrayOutputWithContext

func (o ApiKeyTagArrayOutput) ToApiKeyTagArrayOutputWithContext(ctx context.Context) ApiKeyTagArrayOutput

func (ApiKeyTagArrayOutput) ToOutput added in v0.76.0

type ApiKeyTagInput

type ApiKeyTagInput interface {
	pulumi.Input

	ToApiKeyTagOutput() ApiKeyTagOutput
	ToApiKeyTagOutputWithContext(context.Context) ApiKeyTagOutput
}

ApiKeyTagInput is an input type that accepts ApiKeyTagArgs and ApiKeyTagOutput values. You can construct a concrete instance of `ApiKeyTagInput` via:

ApiKeyTagArgs{...}

type ApiKeyTagOutput

type ApiKeyTagOutput struct{ *pulumi.OutputState }

func (ApiKeyTagOutput) ElementType

func (ApiKeyTagOutput) ElementType() reflect.Type

func (ApiKeyTagOutput) Key

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

func (ApiKeyTagOutput) ToApiKeyTagOutput

func (o ApiKeyTagOutput) ToApiKeyTagOutput() ApiKeyTagOutput

func (ApiKeyTagOutput) ToApiKeyTagOutputWithContext

func (o ApiKeyTagOutput) ToApiKeyTagOutputWithContext(ctx context.Context) ApiKeyTagOutput

func (ApiKeyTagOutput) ToOutput added in v0.76.0

func (ApiKeyTagOutput) Value

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

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.
	AuthorizerCredentials pulumi.StringPtrOutput `pulumi:"authorizerCredentials"`
	AuthorizerId          pulumi.StringOutput    `pulumi:"authorizerId"`
	// The TTL in seconds of cached authorizer results.
	AuthorizerResultTtlInSeconds pulumi.IntPtrOutput `pulumi:"authorizerResultTtlInSeconds"`
	// Specifies the authorizer's Uniform Resource Identifier (URI).
	AuthorizerUri pulumi.StringPtrOutput `pulumi:"authorizerUri"`
	// The identity source for which authorization is requested.
	IdentitySource pulumi.StringPtrOutput `pulumi:"identitySource"`
	// A validation expression for the incoming identity token.
	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.
	ProviderArns pulumi.StringArrayOutput `pulumi:"providerArns"`
	// The identifier of the API.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// The authorizer type.
	Type pulumi.StringOutput `pulumi:"type"`
}

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

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

func (*Authorizer) ToOutput added in v0.76.0

func (i *Authorizer) ToOutput(ctx context.Context) pulumix.Output[*Authorizer]

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.
	AuthorizerCredentials pulumi.StringPtrInput
	// The TTL in seconds of cached authorizer results.
	AuthorizerResultTtlInSeconds pulumi.IntPtrInput
	// Specifies the authorizer's Uniform Resource Identifier (URI).
	AuthorizerUri pulumi.StringPtrInput
	// The identity source for which authorization is requested.
	IdentitySource pulumi.StringPtrInput
	// A validation expression for the incoming identity token.
	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.
	ProviderArns pulumi.StringArrayInput
	// The identifier of the API.
	RestApiId pulumi.StringInput
	// The authorizer type.
	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

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.

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.

func (AuthorizerOutput) AuthorizerUri added in v0.17.0

func (o AuthorizerOutput) AuthorizerUri() pulumi.StringPtrOutput

Specifies the authorizer's Uniform Resource Identifier (URI).

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.

func (AuthorizerOutput) IdentityValidationExpression added in v0.17.0

func (o AuthorizerOutput) IdentityValidationExpression() pulumi.StringPtrOutput

A validation expression for the incoming identity token.

func (AuthorizerOutput) Name added in v0.17.0

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.

func (AuthorizerOutput) RestApiId added in v0.17.0

func (o AuthorizerOutput) RestApiId() pulumi.StringOutput

The identifier of the API.

func (AuthorizerOutput) ToAuthorizerOutput

func (o AuthorizerOutput) ToAuthorizerOutput() AuthorizerOutput

func (AuthorizerOutput) ToAuthorizerOutputWithContext

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

func (AuthorizerOutput) ToOutput added in v0.76.0

func (AuthorizerOutput) Type added in v0.17.0

The authorizer type.

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 in the URL after the domain name.
	BasePath pulumi.StringPtrOutput `pulumi:"basePath"`
	// The DomainName of an AWS::ApiGateway::DomainName resource.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// The ID of the API.
	RestApiId pulumi.StringPtrOutput `pulumi:"restApiId"`
	// The name of the API's stage.
	Stage pulumi.StringPtrOutput `pulumi:"stage"`
}

Resource Type definition for AWS::ApiGateway::BasePathMapping

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

func (*BasePathMapping) ToOutput added in v0.76.0

type BasePathMappingArgs

type BasePathMappingArgs struct {
	// The base path name that callers of the API must provide in the URL after the domain name.
	BasePath pulumi.StringPtrInput
	// The DomainName of an AWS::ApiGateway::DomainName resource.
	DomainName pulumi.StringInput
	// The ID of the API.
	RestApiId pulumi.StringPtrInput
	// The name of the API's 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

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

func (BasePathMappingOutput) DomainName added in v0.17.0

func (o BasePathMappingOutput) DomainName() pulumi.StringOutput

The DomainName of an AWS::ApiGateway::DomainName resource.

func (BasePathMappingOutput) ElementType

func (BasePathMappingOutput) ElementType() reflect.Type

func (BasePathMappingOutput) RestApiId added in v0.17.0

The ID of the API.

func (BasePathMappingOutput) Stage added in v0.17.0

The name of the API's stage.

func (BasePathMappingOutput) ToBasePathMappingOutput

func (o BasePathMappingOutput) ToBasePathMappingOutput() BasePathMappingOutput

func (BasePathMappingOutput) ToBasePathMappingOutputWithContext

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

func (BasePathMappingOutput) ToOutput added in v0.76.0

type BasePathMappingState

type BasePathMappingState struct {
}

func (BasePathMappingState) ElementType

func (BasePathMappingState) ElementType() reflect.Type

type ClientCertificate

type ClientCertificate struct {
	pulumi.CustomResourceState

	// The Primary Identifier of the Client Certficate, generated by a Create API Call
	ClientCertificateId pulumi.StringOutput `pulumi:"clientCertificateId"`
	// A description of the client certificate.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// An array of arbitrary tags (key-value pairs) to associate with the client certificate.
	Tags ClientCertificateTagArrayOutput `pulumi:"tags"`
}

Resource Type definition for AWS::ApiGateway::ClientCertificate

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

func (*ClientCertificate) ToOutput added in v0.76.0

type ClientCertificateArgs

type ClientCertificateArgs struct {
	// A description of the client certificate.
	Description pulumi.StringPtrInput
	// An array of arbitrary tags (key-value pairs) to associate with the client certificate.
	Tags ClientCertificateTagArrayInput
}

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

The Primary Identifier of the Client Certficate, generated by a Create API Call

func (ClientCertificateOutput) Description added in v0.17.0

A description of the client certificate.

func (ClientCertificateOutput) ElementType

func (ClientCertificateOutput) ElementType() reflect.Type

func (ClientCertificateOutput) Tags added in v0.17.0

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

func (ClientCertificateOutput) ToClientCertificateOutput

func (o ClientCertificateOutput) ToClientCertificateOutput() ClientCertificateOutput

func (ClientCertificateOutput) ToClientCertificateOutputWithContext

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

func (ClientCertificateOutput) ToOutput added in v0.76.0

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 ClientCertificateTagArgs

type ClientCertificateTagArgs struct {
	Key   pulumi.StringInput `pulumi:"key"`
	Value pulumi.StringInput `pulumi:"value"`
}

func (ClientCertificateTagArgs) ElementType

func (ClientCertificateTagArgs) ElementType() reflect.Type

func (ClientCertificateTagArgs) ToClientCertificateTagOutput

func (i ClientCertificateTagArgs) ToClientCertificateTagOutput() ClientCertificateTagOutput

func (ClientCertificateTagArgs) ToClientCertificateTagOutputWithContext

func (i ClientCertificateTagArgs) ToClientCertificateTagOutputWithContext(ctx context.Context) ClientCertificateTagOutput

func (ClientCertificateTagArgs) ToOutput added in v0.76.0

type ClientCertificateTagArray

type ClientCertificateTagArray []ClientCertificateTagInput

func (ClientCertificateTagArray) ElementType

func (ClientCertificateTagArray) ElementType() reflect.Type

func (ClientCertificateTagArray) ToClientCertificateTagArrayOutput

func (i ClientCertificateTagArray) ToClientCertificateTagArrayOutput() ClientCertificateTagArrayOutput

func (ClientCertificateTagArray) ToClientCertificateTagArrayOutputWithContext

func (i ClientCertificateTagArray) ToClientCertificateTagArrayOutputWithContext(ctx context.Context) ClientCertificateTagArrayOutput

func (ClientCertificateTagArray) ToOutput added in v0.76.0

type ClientCertificateTagArrayInput

type ClientCertificateTagArrayInput interface {
	pulumi.Input

	ToClientCertificateTagArrayOutput() ClientCertificateTagArrayOutput
	ToClientCertificateTagArrayOutputWithContext(context.Context) ClientCertificateTagArrayOutput
}

ClientCertificateTagArrayInput is an input type that accepts ClientCertificateTagArray and ClientCertificateTagArrayOutput values. You can construct a concrete instance of `ClientCertificateTagArrayInput` via:

ClientCertificateTagArray{ ClientCertificateTagArgs{...} }

type ClientCertificateTagArrayOutput

type ClientCertificateTagArrayOutput struct{ *pulumi.OutputState }

func (ClientCertificateTagArrayOutput) ElementType

func (ClientCertificateTagArrayOutput) Index

func (ClientCertificateTagArrayOutput) ToClientCertificateTagArrayOutput

func (o ClientCertificateTagArrayOutput) ToClientCertificateTagArrayOutput() ClientCertificateTagArrayOutput

func (ClientCertificateTagArrayOutput) ToClientCertificateTagArrayOutputWithContext

func (o ClientCertificateTagArrayOutput) ToClientCertificateTagArrayOutputWithContext(ctx context.Context) ClientCertificateTagArrayOutput

func (ClientCertificateTagArrayOutput) ToOutput added in v0.76.0

type ClientCertificateTagInput

type ClientCertificateTagInput interface {
	pulumi.Input

	ToClientCertificateTagOutput() ClientCertificateTagOutput
	ToClientCertificateTagOutputWithContext(context.Context) ClientCertificateTagOutput
}

ClientCertificateTagInput is an input type that accepts ClientCertificateTagArgs and ClientCertificateTagOutput values. You can construct a concrete instance of `ClientCertificateTagInput` via:

ClientCertificateTagArgs{...}

type ClientCertificateTagOutput

type ClientCertificateTagOutput struct{ *pulumi.OutputState }

func (ClientCertificateTagOutput) ElementType

func (ClientCertificateTagOutput) ElementType() reflect.Type

func (ClientCertificateTagOutput) Key

func (ClientCertificateTagOutput) ToClientCertificateTagOutput

func (o ClientCertificateTagOutput) ToClientCertificateTagOutput() ClientCertificateTagOutput

func (ClientCertificateTagOutput) ToClientCertificateTagOutputWithContext

func (o ClientCertificateTagOutput) ToClientCertificateTagOutputWithContext(ctx context.Context) ClientCertificateTagOutput

func (ClientCertificateTagOutput) ToOutput added in v0.76.0

func (ClientCertificateTagOutput) Value

type Deployment

type Deployment struct {
	pulumi.CustomResourceState

	// Specifies settings for the canary deployment.
	DeploymentCanarySettings DeploymentCanarySettingsPtrOutput `pulumi:"deploymentCanarySettings"`
	// Primary Id for this resource
	DeploymentId pulumi.StringOutput `pulumi:"deploymentId"`
	// A description of the purpose of the API Gateway deployment.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The ID of the RestApi resource to deploy.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// Configures the stage that API Gateway creates with this deployment.
	StageDescription DeploymentStageDescriptionPtrOutput `pulumi:"stageDescription"`
	// A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
	StageName pulumi.StringPtrOutput `pulumi:"stageName"`
}

Resource Type definition for AWS::ApiGateway::Deployment

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

func (*Deployment) ToOutput added in v0.76.0

func (i *Deployment) ToOutput(ctx context.Context) pulumix.Output[*Deployment]

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"`
}

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"`
}

func (DeploymentAccessLogSettingArgs) ElementType

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

func (DeploymentAccessLogSettingArgs) ToOutput added in v0.76.0

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 }

func (DeploymentAccessLogSettingOutput) DestinationArn

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) Format

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

func (DeploymentAccessLogSettingOutput) ToOutput added in v0.76.0

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

type DeploymentAccessLogSettingPtrOutput

type DeploymentAccessLogSettingPtrOutput struct{ *pulumi.OutputState }

func (DeploymentAccessLogSettingPtrOutput) DestinationArn

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 (DeploymentAccessLogSettingPtrOutput) ElementType

func (DeploymentAccessLogSettingPtrOutput) Format

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

func (DeploymentAccessLogSettingPtrOutput) ToOutput added in v0.76.0

type DeploymentArgs

type DeploymentArgs struct {
	// Specifies settings for the canary deployment.
	DeploymentCanarySettings DeploymentCanarySettingsPtrInput
	// A description of the purpose of the API Gateway deployment.
	Description pulumi.StringPtrInput
	// The ID of the RestApi resource to deploy.
	RestApiId pulumi.StringInput
	// Configures the stage that API Gateway creates with this deployment.
	StageDescription DeploymentStageDescriptionPtrInput
	// A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
	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 interface{} `pulumi:"stageVariableOverrides"`
	// Whether the canary deployment uses the stage cache or not.
	UseStageCache *bool `pulumi:"useStageCache"`
}

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.Input `pulumi:"stageVariableOverrides"`
	// Whether the canary deployment uses the stage cache or not.
	UseStageCache pulumi.BoolPtrInput `pulumi:"useStageCache"`
}

func (DeploymentCanarySettingArgs) ElementType

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

func (DeploymentCanarySettingArgs) ToOutput added in v0.76.0

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 }

func (DeploymentCanarySettingOutput) ElementType

func (DeploymentCanarySettingOutput) PercentTraffic

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

func (DeploymentCanarySettingOutput) StageVariableOverrides

func (o DeploymentCanarySettingOutput) StageVariableOverrides() pulumi.AnyOutput

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) ToOutput added in v0.76.0

func (DeploymentCanarySettingOutput) UseStageCache

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

type DeploymentCanarySettingPtrOutput

type DeploymentCanarySettingPtrOutput struct{ *pulumi.OutputState }

func (DeploymentCanarySettingPtrOutput) Elem

func (DeploymentCanarySettingPtrOutput) ElementType

func (DeploymentCanarySettingPtrOutput) PercentTraffic

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

func (DeploymentCanarySettingPtrOutput) StageVariableOverrides

func (o DeploymentCanarySettingPtrOutput) StageVariableOverrides() pulumi.AnyOutput

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) ToOutput added in v0.76.0

func (DeploymentCanarySettingPtrOutput) UseStageCache

Whether the canary deployment uses the stage cache or not.

type DeploymentCanarySettings added in v0.2.0

type DeploymentCanarySettings struct {
	// The percentage (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. Duplicates are not allowed.
	StageVariableOverrides interface{} `pulumi:"stageVariableOverrides"`
	// Whether the canary deployment uses the stage cache.
	UseStageCache *bool `pulumi:"useStageCache"`
}

type DeploymentCanarySettingsArgs added in v0.2.0

type DeploymentCanarySettingsArgs struct {
	// The percentage (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. Duplicates are not allowed.
	StageVariableOverrides pulumi.Input `pulumi:"stageVariableOverrides"`
	// Whether the canary deployment uses the stage cache.
	UseStageCache pulumi.BoolPtrInput `pulumi:"useStageCache"`
}

func (DeploymentCanarySettingsArgs) ElementType added in v0.2.0

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

func (DeploymentCanarySettingsArgs) ToOutput added in v0.76.0

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 }

func (DeploymentCanarySettingsOutput) ElementType added in v0.2.0

func (DeploymentCanarySettingsOutput) PercentTraffic added in v0.2.0

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

func (DeploymentCanarySettingsOutput) StageVariableOverrides added in v0.2.0

func (o DeploymentCanarySettingsOutput) StageVariableOverrides() pulumi.AnyOutput

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. Duplicates are not allowed.

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) ToOutput added in v0.76.0

func (DeploymentCanarySettingsOutput) UseStageCache added in v0.2.0

Whether the canary deployment uses the stage cache.

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 (DeploymentCanarySettingsPtrOutput) ElementType added in v0.2.0

func (DeploymentCanarySettingsPtrOutput) PercentTraffic added in v0.2.0

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

func (DeploymentCanarySettingsPtrOutput) StageVariableOverrides added in v0.2.0

func (o DeploymentCanarySettingsPtrOutput) StageVariableOverrides() pulumi.AnyOutput

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. Duplicates are not allowed.

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) ToOutput added in v0.76.0

func (DeploymentCanarySettingsPtrOutput) UseStageCache added in v0.2.0

Whether the canary deployment uses the stage cache.

type DeploymentInput

type DeploymentInput interface {
	pulumi.Input

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

type DeploymentMethodSetting

type DeploymentMethodSetting struct {
	// 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.
	CachingEnabled *bool `pulumi:"cachingEnabled"`
	// 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"`
	// The HTTP method.
	HttpMethod *string `pulumi:"httpMethod"`
	// The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
	LoggingLevel *string `pulumi:"loggingLevel"`
	// Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
	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.
	ResourcePath *string `pulumi:"resourcePath"`
	// The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingBurstLimit *int `pulumi:"throttlingBurstLimit"`
	// The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingRateLimit *float64 `pulumi:"throttlingRateLimit"`
}

type DeploymentMethodSettingArgs

type DeploymentMethodSettingArgs struct {
	// 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.
	CachingEnabled pulumi.BoolPtrInput `pulumi:"cachingEnabled"`
	// 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"`
	// The HTTP method.
	HttpMethod pulumi.StringPtrInput `pulumi:"httpMethod"`
	// The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
	LoggingLevel pulumi.StringPtrInput `pulumi:"loggingLevel"`
	// Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
	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.
	ResourcePath pulumi.StringPtrInput `pulumi:"resourcePath"`
	// The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingBurstLimit pulumi.IntPtrInput `pulumi:"throttlingBurstLimit"`
	// The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingRateLimit pulumi.Float64PtrInput `pulumi:"throttlingRateLimit"`
}

func (DeploymentMethodSettingArgs) ElementType

func (DeploymentMethodSettingArgs) ToDeploymentMethodSettingOutput

func (i DeploymentMethodSettingArgs) ToDeploymentMethodSettingOutput() DeploymentMethodSettingOutput

func (DeploymentMethodSettingArgs) ToDeploymentMethodSettingOutputWithContext

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

func (DeploymentMethodSettingArgs) ToOutput added in v0.76.0

type DeploymentMethodSettingArray

type DeploymentMethodSettingArray []DeploymentMethodSettingInput

func (DeploymentMethodSettingArray) ElementType

func (DeploymentMethodSettingArray) ToDeploymentMethodSettingArrayOutput

func (i DeploymentMethodSettingArray) ToDeploymentMethodSettingArrayOutput() DeploymentMethodSettingArrayOutput

func (DeploymentMethodSettingArray) ToDeploymentMethodSettingArrayOutputWithContext

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

func (DeploymentMethodSettingArray) ToOutput added in v0.76.0

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) Index

func (DeploymentMethodSettingArrayOutput) ToDeploymentMethodSettingArrayOutput

func (o DeploymentMethodSettingArrayOutput) ToDeploymentMethodSettingArrayOutput() DeploymentMethodSettingArrayOutput

func (DeploymentMethodSettingArrayOutput) ToDeploymentMethodSettingArrayOutputWithContext

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

func (DeploymentMethodSettingArrayOutput) ToOutput added in v0.76.0

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 }

func (DeploymentMethodSettingOutput) CacheDataEncrypted

func (o DeploymentMethodSettingOutput) CacheDataEncrypted() pulumi.BoolPtrOutput

Indicates whether the cached responses are encrypted

func (DeploymentMethodSettingOutput) CacheTtlInSeconds

func (o DeploymentMethodSettingOutput) CacheTtlInSeconds() pulumi.IntPtrOutput

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

func (DeploymentMethodSettingOutput) CachingEnabled

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

func (DeploymentMethodSettingOutput) DataTraceEnabled

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

func (DeploymentMethodSettingOutput) HttpMethod

The HTTP method.

func (DeploymentMethodSettingOutput) LoggingLevel

The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

func (DeploymentMethodSettingOutput) MetricsEnabled

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

func (DeploymentMethodSettingOutput) ResourcePath

The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash.

func (DeploymentMethodSettingOutput) ThrottlingBurstLimit

func (o DeploymentMethodSettingOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

func (DeploymentMethodSettingOutput) ThrottlingRateLimit

func (o DeploymentMethodSettingOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

func (DeploymentMethodSettingOutput) ToDeploymentMethodSettingOutput

func (o DeploymentMethodSettingOutput) ToDeploymentMethodSettingOutput() DeploymentMethodSettingOutput

func (DeploymentMethodSettingOutput) ToDeploymentMethodSettingOutputWithContext

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

func (DeploymentMethodSettingOutput) ToOutput added in v0.76.0

type DeploymentOutput

type DeploymentOutput struct{ *pulumi.OutputState }

func (DeploymentOutput) DeploymentCanarySettings added in v0.17.0

func (o DeploymentOutput) DeploymentCanarySettings() DeploymentCanarySettingsPtrOutput

Specifies settings for the canary deployment.

func (DeploymentOutput) DeploymentId added in v0.17.0

func (o DeploymentOutput) DeploymentId() pulumi.StringOutput

Primary Id for this resource

func (DeploymentOutput) Description added in v0.17.0

func (o DeploymentOutput) Description() pulumi.StringPtrOutput

A description of the purpose of the API Gateway deployment.

func (DeploymentOutput) ElementType

func (DeploymentOutput) ElementType() reflect.Type

func (DeploymentOutput) RestApiId added in v0.17.0

func (o DeploymentOutput) RestApiId() pulumi.StringOutput

The ID of the RestApi resource to deploy.

func (DeploymentOutput) StageDescription added in v0.17.0

Configures the stage that API Gateway creates with this deployment.

func (DeploymentOutput) StageName added in v0.17.0

func (o DeploymentOutput) StageName() pulumi.StringPtrOutput

A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.

func (DeploymentOutput) ToDeploymentOutput

func (o DeploymentOutput) ToDeploymentOutput() DeploymentOutput

func (DeploymentOutput) ToDeploymentOutputWithContext

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

func (DeploymentOutput) ToOutput added in v0.76.0

type DeploymentStageDescription

type DeploymentStageDescription struct {
	// Specifies settings for logging access in this stage.
	AccessLogSetting *DeploymentAccessLogSetting `pulumi:"accessLogSetting"`
	// Indicates whether cache clustering is enabled for the stage.
	CacheClusterEnabled *bool `pulumi:"cacheClusterEnabled"`
	// The size of the stage's cache cluster.
	CacheClusterSize *string `pulumi:"cacheClusterSize"`
	// The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
	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.
	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 Stage 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 number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingBurstLimit *int `pulumi:"throttlingBurstLimit"`
	// The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingRateLimit *float64 `pulumi:"throttlingRateLimit"`
	// Specifies whether active tracing with X-ray is enabled for this stage.
	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 interface{} `pulumi:"variables"`
}

type DeploymentStageDescriptionArgs

type DeploymentStageDescriptionArgs struct {
	// Specifies settings for logging access in this stage.
	AccessLogSetting DeploymentAccessLogSettingPtrInput `pulumi:"accessLogSetting"`
	// Indicates whether cache clustering is enabled for the stage.
	CacheClusterEnabled pulumi.BoolPtrInput `pulumi:"cacheClusterEnabled"`
	// The size of the stage's cache cluster.
	CacheClusterSize pulumi.StringPtrInput `pulumi:"cacheClusterSize"`
	// The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
	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.
	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 Stage 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 number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingBurstLimit pulumi.IntPtrInput `pulumi:"throttlingBurstLimit"`
	// The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingRateLimit pulumi.Float64PtrInput `pulumi:"throttlingRateLimit"`
	// Specifies whether active tracing with X-ray is enabled for this stage.
	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.Input `pulumi:"variables"`
}

func (DeploymentStageDescriptionArgs) ElementType

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

func (DeploymentStageDescriptionArgs) ToOutput added in v0.76.0

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 }

func (DeploymentStageDescriptionOutput) AccessLogSetting

Specifies settings for logging access in this stage.

func (DeploymentStageDescriptionOutput) CacheClusterEnabled

func (o DeploymentStageDescriptionOutput) CacheClusterEnabled() pulumi.BoolPtrOutput

Indicates whether cache clustering is enabled for the stage.

func (DeploymentStageDescriptionOutput) CacheClusterSize

The size of the stage's cache cluster.

func (DeploymentStageDescriptionOutput) CacheDataEncrypted

func (o DeploymentStageDescriptionOutput) CacheDataEncrypted() pulumi.BoolPtrOutput

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

func (DeploymentStageDescriptionOutput) CacheTtlInSeconds

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

func (DeploymentStageDescriptionOutput) CachingEnabled

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

func (DeploymentStageDescriptionOutput) CanarySetting

Specifies settings for the canary deployment in this stage.

func (DeploymentStageDescriptionOutput) ClientCertificateId

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

func (DeploymentStageDescriptionOutput) DataTraceEnabled

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

func (DeploymentStageDescriptionOutput) Description

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) LoggingLevel

The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

func (DeploymentStageDescriptionOutput) MethodSettings

Configures settings for all of the stage's methods.

func (DeploymentStageDescriptionOutput) MetricsEnabled

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

func (DeploymentStageDescriptionOutput) Tags

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

func (DeploymentStageDescriptionOutput) ThrottlingBurstLimit

func (o DeploymentStageDescriptionOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

func (DeploymentStageDescriptionOutput) ThrottlingRateLimit

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

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) ToOutput added in v0.76.0

func (DeploymentStageDescriptionOutput) TracingEnabled

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

func (DeploymentStageDescriptionOutput) Variables

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

type DeploymentStageDescriptionPtrOutput

type DeploymentStageDescriptionPtrOutput struct{ *pulumi.OutputState }

func (DeploymentStageDescriptionPtrOutput) AccessLogSetting

Specifies settings for logging access in this stage.

func (DeploymentStageDescriptionPtrOutput) CacheClusterEnabled

Indicates whether cache clustering is enabled for the stage.

func (DeploymentStageDescriptionPtrOutput) CacheClusterSize

The size of the stage's cache cluster.

func (DeploymentStageDescriptionPtrOutput) CacheDataEncrypted

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

func (DeploymentStageDescriptionPtrOutput) CacheTtlInSeconds

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

func (DeploymentStageDescriptionPtrOutput) CachingEnabled

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

func (DeploymentStageDescriptionPtrOutput) CanarySetting

Specifies settings for the canary deployment in this stage.

func (DeploymentStageDescriptionPtrOutput) ClientCertificateId

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

func (DeploymentStageDescriptionPtrOutput) DataTraceEnabled

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

func (DeploymentStageDescriptionPtrOutput) Description

A description of the purpose of the stage.

func (DeploymentStageDescriptionPtrOutput) DocumentationVersion

The version identifier of the API documentation snapshot.

func (DeploymentStageDescriptionPtrOutput) Elem

func (DeploymentStageDescriptionPtrOutput) ElementType

func (DeploymentStageDescriptionPtrOutput) LoggingLevel

The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

func (DeploymentStageDescriptionPtrOutput) MethodSettings

Configures settings for all of the stage's methods.

func (DeploymentStageDescriptionPtrOutput) MetricsEnabled

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

func (DeploymentStageDescriptionPtrOutput) Tags

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

func (DeploymentStageDescriptionPtrOutput) ThrottlingBurstLimit

func (o DeploymentStageDescriptionPtrOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

func (DeploymentStageDescriptionPtrOutput) ThrottlingRateLimit

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

func (DeploymentStageDescriptionPtrOutput) ToDeploymentStageDescriptionPtrOutput

func (o DeploymentStageDescriptionPtrOutput) ToDeploymentStageDescriptionPtrOutput() DeploymentStageDescriptionPtrOutput

func (DeploymentStageDescriptionPtrOutput) ToDeploymentStageDescriptionPtrOutputWithContext

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

func (DeploymentStageDescriptionPtrOutput) ToOutput added in v0.76.0

func (DeploymentStageDescriptionPtrOutput) TracingEnabled

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

func (DeploymentStageDescriptionPtrOutput) Variables

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

func (DeploymentTagArgs) ToOutput added in v0.76.0

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

func (DeploymentTagArray) ToOutput added in v0.76.0

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 (DeploymentTagArrayOutput) ToDeploymentTagArrayOutput

func (o DeploymentTagArrayOutput) ToDeploymentTagArrayOutput() DeploymentTagArrayOutput

func (DeploymentTagArrayOutput) ToDeploymentTagArrayOutputWithContext

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

func (DeploymentTagArrayOutput) ToOutput added in v0.76.0

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

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) ToOutput added in v0.76.0

func (DeploymentTagOutput) Value

The value for the tag

type DocumentationPart

type DocumentationPart struct {
	pulumi.CustomResourceState

	// The identifier of the documentation Part.
	DocumentationPartId pulumi.StringOutput `pulumi:"documentationPartId"`
	// The location of the API entity that the documentation applies to.
	Location DocumentationPartLocationOutput `pulumi:"location"`
	// The documentation content map of the targeted API entity.
	Properties pulumi.StringOutput `pulumi:"properties"`
	// Identifier of the targeted API entity
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
}

Resource Type definition for AWS::ApiGateway::DocumentationPart

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

func (*DocumentationPart) ToOutput added in v0.76.0

type DocumentationPartArgs

type DocumentationPartArgs struct {
	// The location of the API entity that the documentation applies to.
	Location DocumentationPartLocationInput
	// The documentation content map of the targeted API entity.
	Properties pulumi.StringInput
	// Identifier of the targeted API entity
	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.
	Method *string `pulumi:"method"`
	// The name of the targeted API entity.
	Name *string `pulumi:"name"`
	// The URL path of the target.
	Path *string `pulumi:"path"`
	// The HTTP status code of a response.
	StatusCode *string `pulumi:"statusCode"`
	// The type of API entity that the documentation content applies to.
	Type *DocumentationPartLocationType `pulumi:"type"`
}

type DocumentationPartLocationArgs

type DocumentationPartLocationArgs struct {
	// The HTTP verb of a method.
	Method pulumi.StringPtrInput `pulumi:"method"`
	// The name of the targeted API entity.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The URL path of the target.
	Path pulumi.StringPtrInput `pulumi:"path"`
	// The HTTP status code of a response.
	StatusCode pulumi.StringPtrInput `pulumi:"statusCode"`
	// The type of API entity that the documentation content applies to.
	Type DocumentationPartLocationTypePtrInput `pulumi:"type"`
}

func (DocumentationPartLocationArgs) ElementType

func (DocumentationPartLocationArgs) ToDocumentationPartLocationOutput

func (i DocumentationPartLocationArgs) ToDocumentationPartLocationOutput() DocumentationPartLocationOutput

func (DocumentationPartLocationArgs) ToDocumentationPartLocationOutputWithContext

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

func (DocumentationPartLocationArgs) ToOutput added in v0.76.0

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 }

func (DocumentationPartLocationOutput) ElementType

func (DocumentationPartLocationOutput) Method

The HTTP verb of a method.

func (DocumentationPartLocationOutput) Name

The name of the targeted API entity.

func (DocumentationPartLocationOutput) Path

The URL path of the target.

func (DocumentationPartLocationOutput) StatusCode

The HTTP status code of a response.

func (DocumentationPartLocationOutput) ToDocumentationPartLocationOutput

func (o DocumentationPartLocationOutput) ToDocumentationPartLocationOutput() DocumentationPartLocationOutput

func (DocumentationPartLocationOutput) ToDocumentationPartLocationOutputWithContext

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

func (DocumentationPartLocationOutput) ToOutput added in v0.76.0

func (DocumentationPartLocationOutput) Type

The type of API entity that the documentation content applies to.

type DocumentationPartLocationType added in v0.21.0

type DocumentationPartLocationType string

The type of API entity that the documentation content applies to.

func (DocumentationPartLocationType) ElementType added in v0.21.0

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 (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 (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 DocumentationPartLocationTypeArgs and DocumentationPartLocationTypeOutput values. You can construct a concrete instance of `DocumentationPartLocationTypeInput` via:

DocumentationPartLocationTypeArgs{...}

type DocumentationPartLocationTypeOutput added in v0.21.0

type DocumentationPartLocationTypeOutput struct{ *pulumi.OutputState }

func (DocumentationPartLocationTypeOutput) ElementType added in v0.21.0

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) ToOutput added in v0.76.0

func (DocumentationPartLocationTypeOutput) ToStringOutput added in v0.21.0

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 (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 (DocumentationPartLocationTypePtrOutput) ElementType added in v0.21.0

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) ToOutput added in v0.76.0

func (DocumentationPartLocationTypePtrOutput) ToStringPtrOutput added in v0.21.0

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

The identifier of the documentation Part.

func (DocumentationPartOutput) ElementType

func (DocumentationPartOutput) ElementType() reflect.Type

func (DocumentationPartOutput) Location added in v0.17.0

The location of the API entity that the documentation applies to.

func (DocumentationPartOutput) Properties added in v0.17.0

The documentation content map of the targeted API entity.

func (DocumentationPartOutput) RestApiId added in v0.17.0

Identifier of the targeted API entity

func (DocumentationPartOutput) ToDocumentationPartOutput

func (o DocumentationPartOutput) ToDocumentationPartOutput() DocumentationPartOutput

func (DocumentationPartOutput) ToDocumentationPartOutputWithContext

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

func (DocumentationPartOutput) ToOutput added in v0.76.0

type DocumentationPartState

type DocumentationPartState struct {
}

func (DocumentationPartState) ElementType

func (DocumentationPartState) ElementType() reflect.Type

type DocumentationVersion

type DocumentationVersion struct {
	pulumi.CustomResourceState

	// The description of the API documentation snapshot.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The version identifier of the API documentation snapshot.
	DocumentationVersion pulumi.StringOutput `pulumi:"documentationVersion"`
	// The identifier of the API.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
}

A snapshot of the documentation of an API.

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

func (*DocumentationVersion) ToOutput added in v0.76.0

type DocumentationVersionArgs

type DocumentationVersionArgs struct {
	// The description of the API documentation snapshot.
	Description pulumi.StringPtrInput
	// The version identifier of the API documentation snapshot.
	DocumentationVersion pulumi.StringInput
	// The identifier of the API.
	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

The description of the API documentation snapshot.

func (DocumentationVersionOutput) DocumentationVersion added in v0.17.0

func (o DocumentationVersionOutput) DocumentationVersion() pulumi.StringOutput

The version identifier of the API documentation snapshot.

func (DocumentationVersionOutput) ElementType

func (DocumentationVersionOutput) ElementType() reflect.Type

func (DocumentationVersionOutput) RestApiId added in v0.17.0

The identifier of the API.

func (DocumentationVersionOutput) ToDocumentationVersionOutput

func (o DocumentationVersionOutput) ToDocumentationVersionOutput() DocumentationVersionOutput

func (DocumentationVersionOutput) ToDocumentationVersionOutputWithContext

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

func (DocumentationVersionOutput) ToOutput added in v0.76.0

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                                DomainNameTagArrayOutput                   `pulumi:"tags"`
}

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

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

func (*DomainName) ToOutput added in v0.76.0

func (i *DomainName) ToOutput(ctx context.Context) pulumix.Output[*DomainName]

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                                DomainNameTagArrayInput
}

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) 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

func (DomainNameEndpointConfigurationArgs) ToOutput added in v0.76.0

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) 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) ToOutput added in v0.76.0

func (DomainNameEndpointConfigurationOutput) Types

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

type DomainNameEndpointConfigurationPtrOutput

type DomainNameEndpointConfigurationPtrOutput struct{ *pulumi.OutputState }

func (DomainNameEndpointConfigurationPtrOutput) Elem

func (DomainNameEndpointConfigurationPtrOutput) ElementType

func (DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutput

func (o DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutput() DomainNameEndpointConfigurationPtrOutput

func (DomainNameEndpointConfigurationPtrOutput) ToDomainNameEndpointConfigurationPtrOutputWithContext

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

func (DomainNameEndpointConfigurationPtrOutput) ToOutput added in v0.76.0

func (DomainNameEndpointConfigurationPtrOutput) Types

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) 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

func (DomainNameMutualTlsAuthenticationArgs) ToOutput added in v0.76.0

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) 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) ToOutput added in v0.76.0

func (DomainNameMutualTlsAuthenticationOutput) TruststoreUri

func (DomainNameMutualTlsAuthenticationOutput) TruststoreVersion

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

type DomainNameMutualTlsAuthenticationPtrOutput

type DomainNameMutualTlsAuthenticationPtrOutput struct{ *pulumi.OutputState }

func (DomainNameMutualTlsAuthenticationPtrOutput) Elem

func (DomainNameMutualTlsAuthenticationPtrOutput) ElementType

func (DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutput

func (o DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutput() DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext

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

func (DomainNameMutualTlsAuthenticationPtrOutput) ToOutput added in v0.76.0

func (DomainNameMutualTlsAuthenticationPtrOutput) TruststoreUri

func (DomainNameMutualTlsAuthenticationPtrOutput) TruststoreVersion

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 (DomainNameOutput) MutualTlsAuthentication added in v0.17.0

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 (DomainNameOutput) ToDomainNameOutput

func (o DomainNameOutput) ToDomainNameOutput() DomainNameOutput

func (DomainNameOutput) ToDomainNameOutputWithContext

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

func (DomainNameOutput) ToOutput added in v0.76.0

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 DomainNameTagArgs

type DomainNameTagArgs struct {
	Key   pulumi.StringPtrInput `pulumi:"key"`
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (DomainNameTagArgs) ElementType

func (DomainNameTagArgs) ElementType() reflect.Type

func (DomainNameTagArgs) ToDomainNameTagOutput

func (i DomainNameTagArgs) ToDomainNameTagOutput() DomainNameTagOutput

func (DomainNameTagArgs) ToDomainNameTagOutputWithContext

func (i DomainNameTagArgs) ToDomainNameTagOutputWithContext(ctx context.Context) DomainNameTagOutput

func (DomainNameTagArgs) ToOutput added in v0.76.0

type DomainNameTagArray

type DomainNameTagArray []DomainNameTagInput

func (DomainNameTagArray) ElementType

func (DomainNameTagArray) ElementType() reflect.Type

func (DomainNameTagArray) ToDomainNameTagArrayOutput

func (i DomainNameTagArray) ToDomainNameTagArrayOutput() DomainNameTagArrayOutput

func (DomainNameTagArray) ToDomainNameTagArrayOutputWithContext

func (i DomainNameTagArray) ToDomainNameTagArrayOutputWithContext(ctx context.Context) DomainNameTagArrayOutput

func (DomainNameTagArray) ToOutput added in v0.76.0

type DomainNameTagArrayInput

type DomainNameTagArrayInput interface {
	pulumi.Input

	ToDomainNameTagArrayOutput() DomainNameTagArrayOutput
	ToDomainNameTagArrayOutputWithContext(context.Context) DomainNameTagArrayOutput
}

DomainNameTagArrayInput is an input type that accepts DomainNameTagArray and DomainNameTagArrayOutput values. You can construct a concrete instance of `DomainNameTagArrayInput` via:

DomainNameTagArray{ DomainNameTagArgs{...} }

type DomainNameTagArrayOutput

type DomainNameTagArrayOutput struct{ *pulumi.OutputState }

func (DomainNameTagArrayOutput) ElementType

func (DomainNameTagArrayOutput) ElementType() reflect.Type

func (DomainNameTagArrayOutput) Index

func (DomainNameTagArrayOutput) ToDomainNameTagArrayOutput

func (o DomainNameTagArrayOutput) ToDomainNameTagArrayOutput() DomainNameTagArrayOutput

func (DomainNameTagArrayOutput) ToDomainNameTagArrayOutputWithContext

func (o DomainNameTagArrayOutput) ToDomainNameTagArrayOutputWithContext(ctx context.Context) DomainNameTagArrayOutput

func (DomainNameTagArrayOutput) ToOutput added in v0.76.0

type DomainNameTagInput

type DomainNameTagInput interface {
	pulumi.Input

	ToDomainNameTagOutput() DomainNameTagOutput
	ToDomainNameTagOutputWithContext(context.Context) DomainNameTagOutput
}

DomainNameTagInput is an input type that accepts DomainNameTagArgs and DomainNameTagOutput values. You can construct a concrete instance of `DomainNameTagInput` via:

DomainNameTagArgs{...}

type DomainNameTagOutput

type DomainNameTagOutput struct{ *pulumi.OutputState }

func (DomainNameTagOutput) ElementType

func (DomainNameTagOutput) ElementType() reflect.Type

func (DomainNameTagOutput) Key

func (DomainNameTagOutput) ToDomainNameTagOutput

func (o DomainNameTagOutput) ToDomainNameTagOutput() DomainNameTagOutput

func (DomainNameTagOutput) ToDomainNameTagOutputWithContext

func (o DomainNameTagOutput) ToDomainNameTagOutputWithContext(ctx context.Context) DomainNameTagOutput

func (DomainNameTagOutput) ToOutput added in v0.76.0

func (DomainNameTagOutput) Value

type GatewayResponse deprecated

type GatewayResponse struct {
	pulumi.CustomResourceState

	ResponseParameters pulumi.AnyOutput       `pulumi:"responseParameters"`
	ResponseTemplates  pulumi.AnyOutput       `pulumi:"responseTemplates"`
	ResponseType       pulumi.StringOutput    `pulumi:"responseType"`
	RestApiId          pulumi.StringOutput    `pulumi:"restApiId"`
	StatusCode         pulumi.StringPtrOutput `pulumi:"statusCode"`
}

Resource Type definition for AWS::ApiGateway::GatewayResponse

Deprecated: GatewayResponse is not yet supported by AWS Native, so its creation will currently fail. Please use the classic AWS provider, if possible.

func GetGatewayResponse

func GetGatewayResponse(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GatewayResponseState, opts ...pulumi.ResourceOption) (*GatewayResponse, error)

GetGatewayResponse gets an existing GatewayResponse 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 NewGatewayResponse

func NewGatewayResponse(ctx *pulumi.Context,
	name string, args *GatewayResponseArgs, opts ...pulumi.ResourceOption) (*GatewayResponse, error)

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

func (*GatewayResponse) ElementType

func (*GatewayResponse) ElementType() reflect.Type

func (*GatewayResponse) ToGatewayResponseOutput

func (i *GatewayResponse) ToGatewayResponseOutput() GatewayResponseOutput

func (*GatewayResponse) ToGatewayResponseOutputWithContext

func (i *GatewayResponse) ToGatewayResponseOutputWithContext(ctx context.Context) GatewayResponseOutput

func (*GatewayResponse) ToOutput added in v0.76.0

type GatewayResponseArgs

type GatewayResponseArgs struct {
	ResponseParameters pulumi.Input
	ResponseTemplates  pulumi.Input
	ResponseType       pulumi.StringInput
	RestApiId          pulumi.StringInput
	StatusCode         pulumi.StringPtrInput
}

The set of arguments for constructing a GatewayResponse resource.

func (GatewayResponseArgs) ElementType

func (GatewayResponseArgs) ElementType() reflect.Type

type GatewayResponseInput

type GatewayResponseInput interface {
	pulumi.Input

	ToGatewayResponseOutput() GatewayResponseOutput
	ToGatewayResponseOutputWithContext(ctx context.Context) GatewayResponseOutput
}

type GatewayResponseOutput

type GatewayResponseOutput struct{ *pulumi.OutputState }

func (GatewayResponseOutput) ElementType

func (GatewayResponseOutput) ElementType() reflect.Type

func (GatewayResponseOutput) ResponseParameters added in v0.17.0

func (o GatewayResponseOutput) ResponseParameters() pulumi.AnyOutput

func (GatewayResponseOutput) ResponseTemplates added in v0.17.0

func (o GatewayResponseOutput) ResponseTemplates() pulumi.AnyOutput

func (GatewayResponseOutput) ResponseType added in v0.17.0

func (o GatewayResponseOutput) ResponseType() pulumi.StringOutput

func (GatewayResponseOutput) RestApiId added in v0.17.0

func (GatewayResponseOutput) StatusCode added in v0.17.0

func (GatewayResponseOutput) ToGatewayResponseOutput

func (o GatewayResponseOutput) ToGatewayResponseOutput() GatewayResponseOutput

func (GatewayResponseOutput) ToGatewayResponseOutputWithContext

func (o GatewayResponseOutput) ToGatewayResponseOutputWithContext(ctx context.Context) GatewayResponseOutput

func (GatewayResponseOutput) ToOutput added in v0.76.0

type GatewayResponseState

type GatewayResponseState struct {
}

func (GatewayResponseState) ElementType

func (GatewayResponseState) ElementType() reflect.Type

type LookupAccountArgs added in v0.12.0

type LookupAccountArgs struct {
	// Primary identifier which is manually generated.
	Id string `pulumi:"id"`
}

type LookupAccountOutputArgs added in v0.12.0

type LookupAccountOutputArgs struct {
	// Primary identifier which is manually generated.
	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 Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.
	CloudWatchRoleArn *string `pulumi:"cloudWatchRoleArn"`
	// Primary identifier which is manually generated.
	Id *string `pulumi:"id"`
}

func LookupAccount added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::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 Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.

func (LookupAccountResultOutput) ElementType added in v0.12.0

func (LookupAccountResultOutput) ElementType() reflect.Type

func (LookupAccountResultOutput) Id added in v0.12.0

Primary identifier which is manually generated.

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

func (LookupAccountResultOutput) ToOutput added in v0.76.0

type LookupApiKeyArgs added in v0.12.0

type LookupApiKeyArgs struct {
	// A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
	ApiKeyId string `pulumi:"apiKeyId"`
}

type LookupApiKeyOutputArgs added in v0.12.0

type LookupApiKeyOutputArgs struct {
	// A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
	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 {
	// A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
	ApiKeyId *string `pulumi:"apiKeyId"`
	// An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
	CustomerId *string `pulumi:"customerId"`
	// A description of the purpose of the API key.
	Description *string `pulumi:"description"`
	// Indicates whether the API key can be used by clients.
	Enabled *bool `pulumi:"enabled"`
	// A list of stages to associate with this API key.
	StageKeys []ApiKeyStageKey `pulumi:"stageKeys"`
	// An array of arbitrary tags (key-value pairs) to associate with the API key.
	Tags []ApiKeyTag `pulumi:"tags"`
}

func LookupApiKey added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::ApiKey

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

A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

func (LookupApiKeyResultOutput) CustomerId added in v0.12.0

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

func (LookupApiKeyResultOutput) Description added in v0.12.0

A description of the purpose of the API key.

func (LookupApiKeyResultOutput) ElementType added in v0.12.0

func (LookupApiKeyResultOutput) ElementType() reflect.Type

func (LookupApiKeyResultOutput) Enabled added in v0.12.0

Indicates whether the API key can be used by clients.

func (LookupApiKeyResultOutput) StageKeys added in v0.12.0

A list of stages to associate with this API key.

func (LookupApiKeyResultOutput) Tags added in v0.12.0

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

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

func (LookupApiKeyResultOutput) ToOutput added in v0.76.0

type LookupAuthorizerArgs added in v0.12.0

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

type LookupAuthorizerOutputArgs added in v0.12.0

type LookupAuthorizerOutputArgs struct {
	AuthorizerId pulumi.StringInput `pulumi:"authorizerId"`
	// The identifier of the API.
	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.
	AuthorizerCredentials *string `pulumi:"authorizerCredentials"`
	AuthorizerId          *string `pulumi:"authorizerId"`
	// The TTL in seconds of cached authorizer results.
	AuthorizerResultTtlInSeconds *int `pulumi:"authorizerResultTtlInSeconds"`
	// Specifies the authorizer's Uniform Resource Identifier (URI).
	AuthorizerUri *string `pulumi:"authorizerUri"`
	// The identity source for which authorization is requested.
	IdentitySource *string `pulumi:"identitySource"`
	// A validation expression for the incoming identity token.
	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.
	ProviderArns []string `pulumi:"providerArns"`
	// The authorizer type.
	Type *string `pulumi:"type"`
}

func LookupAuthorizer added in v0.12.0

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

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

type LookupAuthorizerResultOutput added in v0.12.0

type LookupAuthorizerResultOutput struct{ *pulumi.OutputState }

func LookupAuthorizerOutput added in v0.12.0

func (LookupAuthorizerResultOutput) AuthType added in v0.12.0

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.

func (LookupAuthorizerResultOutput) AuthorizerId added in v0.12.0

func (LookupAuthorizerResultOutput) AuthorizerResultTtlInSeconds added in v0.12.0

func (o LookupAuthorizerResultOutput) AuthorizerResultTtlInSeconds() pulumi.IntPtrOutput

The TTL in seconds of cached authorizer results.

func (LookupAuthorizerResultOutput) AuthorizerUri added in v0.12.0

Specifies the authorizer's Uniform Resource Identifier (URI).

func (LookupAuthorizerResultOutput) ElementType added in v0.12.0

func (LookupAuthorizerResultOutput) IdentitySource added in v0.12.0

The identity source for which authorization is requested.

func (LookupAuthorizerResultOutput) IdentityValidationExpression added in v0.12.0

func (o LookupAuthorizerResultOutput) IdentityValidationExpression() pulumi.StringPtrOutput

A validation expression for the incoming identity token.

func (LookupAuthorizerResultOutput) Name added in v0.12.0

The name of the authorizer.

func (LookupAuthorizerResultOutput) ProviderArns added in v0.72.0

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.

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) ToOutput added in v0.76.0

func (LookupAuthorizerResultOutput) Type added in v0.12.0

The authorizer type.

type LookupBasePathMappingArgs added in v0.12.0

type LookupBasePathMappingArgs struct {
	// The base path name that callers of the API must provide in the URL after the domain name.
	BasePath string `pulumi:"basePath"`
	// The DomainName of an AWS::ApiGateway::DomainName resource.
	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 in the URL after the domain name.
	BasePath pulumi.StringInput `pulumi:"basePath"`
	// The DomainName of an AWS::ApiGateway::DomainName resource.
	DomainName pulumi.StringInput `pulumi:"domainName"`
}

func (LookupBasePathMappingOutputArgs) ElementType added in v0.12.0

type LookupBasePathMappingResult added in v0.12.0

type LookupBasePathMappingResult struct {
	// The ID of the API.
	RestApiId *string `pulumi:"restApiId"`
	// The name of the API's stage.
	Stage *string `pulumi:"stage"`
}

func LookupBasePathMapping added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::BasePathMapping

type LookupBasePathMappingResultOutput added in v0.12.0

type LookupBasePathMappingResultOutput struct{ *pulumi.OutputState }

func LookupBasePathMappingOutput added in v0.12.0

func (LookupBasePathMappingResultOutput) ElementType added in v0.12.0

func (LookupBasePathMappingResultOutput) RestApiId added in v0.12.0

The ID of the API.

func (LookupBasePathMappingResultOutput) Stage added in v0.12.0

The name of the API's 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

func (LookupBasePathMappingResultOutput) ToOutput added in v0.76.0

type LookupClientCertificateArgs added in v0.12.0

type LookupClientCertificateArgs struct {
	// The Primary Identifier of the Client Certficate, generated by a Create API Call
	ClientCertificateId string `pulumi:"clientCertificateId"`
}

type LookupClientCertificateOutputArgs added in v0.12.0

type LookupClientCertificateOutputArgs struct {
	// The Primary Identifier of the Client Certficate, generated by a Create API Call
	ClientCertificateId pulumi.StringInput `pulumi:"clientCertificateId"`
}

func (LookupClientCertificateOutputArgs) ElementType added in v0.12.0

type LookupClientCertificateResult added in v0.12.0

type LookupClientCertificateResult struct {
	// The Primary Identifier of the Client Certficate, generated by a Create API Call
	ClientCertificateId *string `pulumi:"clientCertificateId"`
	// A description of the client certificate.
	Description *string `pulumi:"description"`
	// An array of arbitrary tags (key-value pairs) to associate with the client certificate.
	Tags []ClientCertificateTag `pulumi:"tags"`
}

func LookupClientCertificate added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::ClientCertificate

type LookupClientCertificateResultOutput added in v0.12.0

type LookupClientCertificateResultOutput struct{ *pulumi.OutputState }

func LookupClientCertificateOutput added in v0.12.0

func (LookupClientCertificateResultOutput) ClientCertificateId added in v0.12.0

The Primary Identifier of the Client Certficate, generated by a Create API Call

func (LookupClientCertificateResultOutput) Description added in v0.12.0

A description of the client certificate.

func (LookupClientCertificateResultOutput) ElementType added in v0.12.0

func (LookupClientCertificateResultOutput) Tags added in v0.12.0

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

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

func (LookupClientCertificateResultOutput) ToOutput added in v0.76.0

type LookupDeploymentArgs added in v0.12.0

type LookupDeploymentArgs struct {
	// Primary Id for this resource
	DeploymentId string `pulumi:"deploymentId"`
	// The ID of the RestApi resource to deploy.
	RestApiId string `pulumi:"restApiId"`
}

type LookupDeploymentOutputArgs added in v0.12.0

type LookupDeploymentOutputArgs struct {
	// Primary Id for this resource
	DeploymentId pulumi.StringInput `pulumi:"deploymentId"`
	// The ID of the RestApi resource to deploy.
	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 {
	// Primary Id for this resource
	DeploymentId *string `pulumi:"deploymentId"`
	// A description of the purpose of the API Gateway deployment.
	Description *string `pulumi:"description"`
}

func LookupDeployment added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::Deployment

type LookupDeploymentResultOutput added in v0.12.0

type LookupDeploymentResultOutput struct{ *pulumi.OutputState }

func LookupDeploymentOutput added in v0.12.0

func (LookupDeploymentResultOutput) DeploymentId added in v0.12.0

Primary Id for this resource

func (LookupDeploymentResultOutput) Description added in v0.12.0

A description of the purpose of the API Gateway deployment.

func (LookupDeploymentResultOutput) ElementType added in v0.12.0

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

func (LookupDeploymentResultOutput) ToOutput added in v0.76.0

type LookupDocumentationPartArgs added in v0.12.0

type LookupDocumentationPartArgs struct {
	// The identifier of the documentation Part.
	DocumentationPartId string `pulumi:"documentationPartId"`
	// Identifier of the targeted API entity
	RestApiId string `pulumi:"restApiId"`
}

type LookupDocumentationPartOutputArgs added in v0.12.0

type LookupDocumentationPartOutputArgs struct {
	// The identifier of the documentation Part.
	DocumentationPartId pulumi.StringInput `pulumi:"documentationPartId"`
	// Identifier of the targeted API entity
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupDocumentationPartOutputArgs) ElementType added in v0.12.0

type LookupDocumentationPartResult added in v0.12.0

type LookupDocumentationPartResult struct {
	// The identifier of the documentation Part.
	DocumentationPartId *string `pulumi:"documentationPartId"`
	// The documentation content map of the targeted API entity.
	Properties *string `pulumi:"properties"`
}

func LookupDocumentationPart added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::DocumentationPart

type LookupDocumentationPartResultOutput added in v0.12.0

type LookupDocumentationPartResultOutput struct{ *pulumi.OutputState }

func LookupDocumentationPartOutput added in v0.12.0

func (LookupDocumentationPartResultOutput) DocumentationPartId added in v0.21.0

The identifier of the documentation Part.

func (LookupDocumentationPartResultOutput) ElementType added in v0.12.0

func (LookupDocumentationPartResultOutput) Properties added in v0.12.0

The documentation content map of the targeted API entity.

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

func (LookupDocumentationPartResultOutput) ToOutput added in v0.76.0

type LookupDocumentationVersionArgs added in v0.12.0

type LookupDocumentationVersionArgs struct {
	// The version identifier of the API documentation snapshot.
	DocumentationVersion string `pulumi:"documentationVersion"`
	// The identifier of the API.
	RestApiId string `pulumi:"restApiId"`
}

type LookupDocumentationVersionOutputArgs added in v0.12.0

type LookupDocumentationVersionOutputArgs struct {
	// The version identifier of the API documentation snapshot.
	DocumentationVersion pulumi.StringInput `pulumi:"documentationVersion"`
	// The identifier of the API.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupDocumentationVersionOutputArgs) ElementType added in v0.12.0

type LookupDocumentationVersionResult added in v0.12.0

type LookupDocumentationVersionResult struct {
	// The description of the API 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)

A snapshot of the documentation of an API.

type LookupDocumentationVersionResultOutput added in v0.12.0

type LookupDocumentationVersionResultOutput struct{ *pulumi.OutputState }

func (LookupDocumentationVersionResultOutput) Description added in v0.12.0

The description of the API documentation snapshot.

func (LookupDocumentationVersionResultOutput) ElementType added in v0.12.0

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

func (LookupDocumentationVersionResultOutput) ToOutput added in v0.76.0

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                                []DomainNameTag                    `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 (LookupDomainNameResultOutput) CertificateArn added in v0.12.0

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) EndpointConfiguration added in v0.12.0

func (LookupDomainNameResultOutput) MutualTlsAuthentication added in v0.12.0

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 (LookupDomainNameResultOutput) Tags added in v0.12.0

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

func (LookupDomainNameResultOutput) ToOutput added in v0.76.0

type LookupGatewayResponseArgs added in v0.12.0

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

type LookupGatewayResponseOutputArgs added in v0.12.0

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

func (LookupGatewayResponseOutputArgs) ElementType added in v0.12.0

type LookupGatewayResponseResult added in v0.12.0

type LookupGatewayResponseResult struct {
	Id                 *string     `pulumi:"id"`
	ResponseParameters interface{} `pulumi:"responseParameters"`
	ResponseTemplates  interface{} `pulumi:"responseTemplates"`
	StatusCode         *string     `pulumi:"statusCode"`
}

func LookupGatewayResponse added in v0.12.0

func LookupGatewayResponse(ctx *pulumi.Context, args *LookupGatewayResponseArgs, opts ...pulumi.InvokeOption) (*LookupGatewayResponseResult, error)

Resource Type definition for AWS::ApiGateway::GatewayResponse

type LookupGatewayResponseResultOutput added in v0.12.0

type LookupGatewayResponseResultOutput struct{ *pulumi.OutputState }

func LookupGatewayResponseOutput added in v0.12.0

func (LookupGatewayResponseResultOutput) ElementType added in v0.12.0

func (LookupGatewayResponseResultOutput) Id added in v0.12.0

func (LookupGatewayResponseResultOutput) ResponseParameters added in v0.12.0

func (o LookupGatewayResponseResultOutput) ResponseParameters() pulumi.AnyOutput

func (LookupGatewayResponseResultOutput) ResponseTemplates added in v0.12.0

func (o LookupGatewayResponseResultOutput) ResponseTemplates() pulumi.AnyOutput

func (LookupGatewayResponseResultOutput) StatusCode added in v0.12.0

func (LookupGatewayResponseResultOutput) ToLookupGatewayResponseResultOutput added in v0.12.0

func (o LookupGatewayResponseResultOutput) ToLookupGatewayResponseResultOutput() LookupGatewayResponseResultOutput

func (LookupGatewayResponseResultOutput) ToLookupGatewayResponseResultOutputWithContext added in v0.12.0

func (o LookupGatewayResponseResultOutput) ToLookupGatewayResponseResultOutputWithContext(ctx context.Context) LookupGatewayResponseResultOutput

func (LookupGatewayResponseResultOutput) ToOutput added in v0.76.0

type LookupMethodArgs added in v0.12.0

type LookupMethodArgs struct {
	// The backend system that the method calls when it receives a request.
	HttpMethod string `pulumi:"httpMethod"`
	// The ID of an API Gateway resource.
	ResourceId string `pulumi:"resourceId"`
	// The ID of the RestApi resource in which API Gateway creates the method.
	RestApiId string `pulumi:"restApiId"`
}

type LookupMethodOutputArgs added in v0.12.0

type LookupMethodOutputArgs struct {
	// The backend system that the method calls when it receives a request.
	HttpMethod pulumi.StringInput `pulumi:"httpMethod"`
	// The ID of an API Gateway resource.
	ResourceId pulumi.StringInput `pulumi:"resourceId"`
	// The ID of the RestApi resource in which API Gateway creates the method.
	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 {
	// Indicates whether the method requires clients to submit a valid API key.
	ApiKeyRequired *bool `pulumi:"apiKeyRequired"`
	// A list of authorization scopes configured on the method.
	AuthorizationScopes []string `pulumi:"authorizationScopes"`
	// The method's authorization type.
	AuthorizationType *MethodAuthorizationType `pulumi:"authorizationType"`
	// The identifier of the authorizer to use on this method.
	AuthorizerId *string `pulumi:"authorizerId"`
	// The backend system that the method calls when it receives a request.
	Integration *MethodIntegration `pulumi:"integration"`
	// The responses that can be sent to the client who calls the method.
	MethodResponses []MethodResponse `pulumi:"methodResponses"`
	// A friendly operation name for the method.
	OperationName *string `pulumi:"operationName"`
	// The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
	RequestModels interface{} `pulumi:"requestModels"`
	// The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
	RequestParameters interface{} `pulumi:"requestParameters"`
	// The ID of the associated request validator.
	RequestValidatorId *string `pulumi:"requestValidatorId"`
}

func LookupMethod added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::Method

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

Indicates whether the method requires clients to submit a valid API key.

func (LookupMethodResultOutput) AuthorizationScopes added in v0.12.0

func (o LookupMethodResultOutput) AuthorizationScopes() pulumi.StringArrayOutput

A list of authorization scopes configured on the method.

func (LookupMethodResultOutput) AuthorizationType added in v0.12.0

The method's authorization type.

func (LookupMethodResultOutput) AuthorizerId added in v0.12.0

The identifier of the authorizer to use on this method.

func (LookupMethodResultOutput) ElementType added in v0.12.0

func (LookupMethodResultOutput) ElementType() reflect.Type

func (LookupMethodResultOutput) Integration added in v0.12.0

The backend system that the method calls when it receives a request.

func (LookupMethodResultOutput) MethodResponses added in v0.12.0

The responses that can be sent to the client who calls the method.

func (LookupMethodResultOutput) OperationName added in v0.12.0

A friendly operation name for the method.

func (LookupMethodResultOutput) RequestModels added in v0.12.0

func (o LookupMethodResultOutput) RequestModels() pulumi.AnyOutput

The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.

func (LookupMethodResultOutput) RequestParameters added in v0.12.0

func (o LookupMethodResultOutput) RequestParameters() pulumi.AnyOutput

The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.

func (LookupMethodResultOutput) RequestValidatorId added in v0.12.0

func (o LookupMethodResultOutput) RequestValidatorId() pulumi.StringPtrOutput

The ID of the associated request validator.

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

func (LookupMethodResultOutput) ToOutput added in v0.76.0

type LookupModelArgs added in v0.12.0

type LookupModelArgs struct {
	// A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
	Name string `pulumi:"name"`
	// The ID of a REST API with which to associate this model.
	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, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
	Name pulumi.StringInput `pulumi:"name"`
	// The ID of a REST API with which to associate this model.
	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 {
	// A description that identifies this model.
	Description *string `pulumi:"description"`
	// The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
	Schema interface{} `pulumi:"schema"`
}

func LookupModel added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::Model

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

A description that identifies this model.

func (LookupModelResultOutput) ElementType added in v0.12.0

func (LookupModelResultOutput) ElementType() reflect.Type

func (LookupModelResultOutput) Schema added in v0.12.0

The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.

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

func (LookupModelResultOutput) ToOutput added in v0.76.0

type LookupRequestValidatorArgs added in v0.12.0

type LookupRequestValidatorArgs struct {
	// ID of the request validator.
	RequestValidatorId string `pulumi:"requestValidatorId"`
	// The identifier of the targeted API entity.
	RestApiId string `pulumi:"restApiId"`
}

type LookupRequestValidatorOutputArgs added in v0.12.0

type LookupRequestValidatorOutputArgs struct {
	// ID of the request validator.
	RequestValidatorId pulumi.StringInput `pulumi:"requestValidatorId"`
	// The identifier of the targeted API entity.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
}

func (LookupRequestValidatorOutputArgs) ElementType added in v0.12.0

type LookupRequestValidatorResult added in v0.12.0

type LookupRequestValidatorResult struct {
	// ID of the request validator.
	RequestValidatorId *string `pulumi:"requestValidatorId"`
	// Indicates whether to validate the request body according to the configured schema for the targeted API and method.
	ValidateRequestBody *bool `pulumi:"validateRequestBody"`
	// Indicates whether to validate request parameters.
	ValidateRequestParameters *bool `pulumi:"validateRequestParameters"`
}

func LookupRequestValidator added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::RequestValidator

type LookupRequestValidatorResultOutput added in v0.12.0

type LookupRequestValidatorResultOutput struct{ *pulumi.OutputState }

func LookupRequestValidatorOutput added in v0.12.0

func (LookupRequestValidatorResultOutput) ElementType added in v0.12.0

func (LookupRequestValidatorResultOutput) RequestValidatorId added in v0.12.0

ID of the request validator.

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) ToOutput added in v0.76.0

func (LookupRequestValidatorResultOutput) ValidateRequestBody added in v0.12.0

Indicates whether to validate the request body according to the configured schema for the targeted API and method.

func (LookupRequestValidatorResultOutput) ValidateRequestParameters added in v0.12.0

func (o LookupRequestValidatorResultOutput) ValidateRequestParameters() pulumi.BoolPtrOutput

Indicates whether to validate request parameters.

type LookupResourceArgs added in v0.12.0

type LookupResourceArgs struct {
	// A unique primary identifier for a Resource
	ResourceId string `pulumi:"resourceId"`
	// The ID of the RestApi resource in which you want to create this resource..
	RestApiId string `pulumi:"restApiId"`
}

type LookupResourceOutputArgs added in v0.12.0

type LookupResourceOutputArgs struct {
	// A unique primary identifier for a Resource
	ResourceId pulumi.StringInput `pulumi:"resourceId"`
	// The ID of the RestApi resource in which you want to create this resource..
	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 {
	// A unique primary identifier for a Resource
	ResourceId *string `pulumi:"resourceId"`
}

func LookupResource added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::Resource

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

A unique primary identifier for a Resource

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

func (LookupResourceResultOutput) ToOutput added in v0.76.0

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 {
	ApiKeySourceType          *string                       `pulumi:"apiKeySourceType"`
	BinaryMediaTypes          []string                      `pulumi:"binaryMediaTypes"`
	Description               *string                       `pulumi:"description"`
	DisableExecuteApiEndpoint *bool                         `pulumi:"disableExecuteApiEndpoint"`
	EndpointConfiguration     *RestApiEndpointConfiguration `pulumi:"endpointConfiguration"`
	MinimumCompressionSize    *int                          `pulumi:"minimumCompressionSize"`
	Name                      *string                       `pulumi:"name"`
	Policy                    interface{}                   `pulumi:"policy"`
	RestApiId                 *string                       `pulumi:"restApiId"`
	RootResourceId            *string                       `pulumi:"rootResourceId"`
	Tags                      []RestApiTag                  `pulumi:"tags"`
}

func LookupRestApi added in v0.12.0

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

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

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

func (LookupRestApiResultOutput) BinaryMediaTypes added in v0.12.0

func (o LookupRestApiResultOutput) BinaryMediaTypes() pulumi.StringArrayOutput

func (LookupRestApiResultOutput) Description added in v0.12.0

func (LookupRestApiResultOutput) DisableExecuteApiEndpoint added in v0.12.0

func (o LookupRestApiResultOutput) DisableExecuteApiEndpoint() pulumi.BoolPtrOutput

func (LookupRestApiResultOutput) ElementType added in v0.12.0

func (LookupRestApiResultOutput) ElementType() reflect.Type

func (LookupRestApiResultOutput) EndpointConfiguration added in v0.12.0

func (LookupRestApiResultOutput) MinimumCompressionSize added in v0.12.0

func (o LookupRestApiResultOutput) MinimumCompressionSize() pulumi.IntPtrOutput

func (LookupRestApiResultOutput) Name added in v0.12.0

func (LookupRestApiResultOutput) Policy added in v0.12.0

func (LookupRestApiResultOutput) RestApiId added in v0.44.0

func (LookupRestApiResultOutput) RootResourceId added in v0.12.0

func (LookupRestApiResultOutput) Tags added in v0.12.0

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

func (LookupRestApiResultOutput) ToOutput added in v0.76.0

type LookupStageArgs added in v0.12.0

type LookupStageArgs struct {
	// The ID of the RestApi resource that you're deploying with this stage.
	RestApiId string `pulumi:"restApiId"`
	// The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
	StageName string `pulumi:"stageName"`
}

type LookupStageOutputArgs added in v0.12.0

type LookupStageOutputArgs struct {
	// The ID of the RestApi resource that you're deploying with this stage.
	RestApiId pulumi.StringInput `pulumi:"restApiId"`
	// The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
	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 {
	// Specifies settings for logging access in this stage.
	AccessLogSetting *StageAccessLogSetting `pulumi:"accessLogSetting"`
	// Indicates whether cache clustering is enabled for the stage.
	CacheClusterEnabled *bool `pulumi:"cacheClusterEnabled"`
	// The stage's cache cluster size.
	CacheClusterSize *string `pulumi:"cacheClusterSize"`
	// Specifies settings for the canary deployment in this stage.
	CanarySetting *StageCanarySetting `pulumi:"canarySetting"`
	// The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
	ClientCertificateId *string `pulumi:"clientCertificateId"`
	// The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
	DeploymentId *string `pulumi:"deploymentId"`
	// A description of the stage.
	Description *string `pulumi:"description"`
	// The version ID of the API documentation snapshot.
	DocumentationVersion *string `pulumi:"documentationVersion"`
	// Settings for all methods in the stage.
	MethodSettings []StageMethodSetting `pulumi:"methodSettings"`
	// An array of arbitrary tags (key-value pairs) to associate with the stage.
	Tags []StageTag `pulumi:"tags"`
	// Specifies whether active X-Ray tracing is enabled for this 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.
	Variables interface{} `pulumi:"variables"`
}

func LookupStage added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::Stage

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

Specifies settings for logging access in this stage.

func (LookupStageResultOutput) CacheClusterEnabled added in v0.12.0

func (o LookupStageResultOutput) CacheClusterEnabled() pulumi.BoolPtrOutput

Indicates whether cache clustering is enabled for the stage.

func (LookupStageResultOutput) CacheClusterSize added in v0.12.0

func (o LookupStageResultOutput) CacheClusterSize() pulumi.StringPtrOutput

The stage's cache cluster size.

func (LookupStageResultOutput) CanarySetting added in v0.12.0

Specifies settings for the canary deployment in this stage.

func (LookupStageResultOutput) ClientCertificateId added in v0.12.0

func (o LookupStageResultOutput) ClientCertificateId() pulumi.StringPtrOutput

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

func (LookupStageResultOutput) DeploymentId added in v0.12.0

The ID of the deployment that the stage is associated with. This parameter is required to create a stage.

func (LookupStageResultOutput) Description added in v0.12.0

A description of the stage.

func (LookupStageResultOutput) DocumentationVersion added in v0.12.0

func (o LookupStageResultOutput) DocumentationVersion() pulumi.StringPtrOutput

The version ID of the API documentation snapshot.

func (LookupStageResultOutput) ElementType added in v0.12.0

func (LookupStageResultOutput) ElementType() reflect.Type

func (LookupStageResultOutput) MethodSettings added in v0.12.0

Settings for all methods in the stage.

func (LookupStageResultOutput) Tags added in v0.12.0

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

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) ToOutput added in v0.76.0

func (LookupStageResultOutput) TracingEnabled added in v0.12.0

func (o LookupStageResultOutput) TracingEnabled() pulumi.BoolPtrOutput

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

func (LookupStageResultOutput) Variables added in v0.12.0

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.

type LookupUsagePlanArgs added in v0.12.0

type LookupUsagePlanArgs struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
}

type LookupUsagePlanKeyArgs added in v0.12.0

type LookupUsagePlanKeyArgs struct {
	// An autogenerated ID which is a combination of the ID of the key and ID of the usage plan combined with a : such as 123abcdef:abc123.
	Id string `pulumi:"id"`
}

type LookupUsagePlanKeyOutputArgs added in v0.12.0

type LookupUsagePlanKeyOutputArgs struct {
	// An autogenerated ID which is a combination of the ID of the key and ID of the usage plan combined with a : such as 123abcdef:abc123.
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupUsagePlanKeyOutputArgs) ElementType added in v0.12.0

type LookupUsagePlanKeyResult added in v0.12.0

type LookupUsagePlanKeyResult struct {
	// An autogenerated ID which is a combination of the ID of the key and ID of the usage plan combined with a : such as 123abcdef:abc123.
	Id *string `pulumi:"id"`
}

func LookupUsagePlanKey added in v0.12.0

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

Resource Type definition for AWS::ApiGateway::UsagePlanKey

type LookupUsagePlanKeyResultOutput added in v0.12.0

type LookupUsagePlanKeyResultOutput struct{ *pulumi.OutputState }

func LookupUsagePlanKeyOutput added in v0.12.0

func (LookupUsagePlanKeyResultOutput) ElementType added in v0.12.0

func (LookupUsagePlanKeyResultOutput) Id added in v0.12.0

An autogenerated ID which is a combination of the ID of the key and ID of the usage plan combined with a : such as 123abcdef:abc123.

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

func (LookupUsagePlanKeyResultOutput) ToOutput added in v0.76.0

type LookupUsagePlanOutputArgs added in v0.12.0

type LookupUsagePlanOutputArgs struct {
	// The provider-assigned unique ID for this managed resource.
	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 API stages to associate with this usage plan.
	ApiStages []UsagePlanApiStage `pulumi:"apiStages"`
	// A description of the usage plan.
	Description *string `pulumi:"description"`
	// The provider-assigned unique ID for this managed resource.
	Id *string `pulumi:"id"`
	// Configures the number of requests that users can make within a given interval.
	Quota *UsagePlanQuotaSettings `pulumi:"quota"`
	// An array of arbitrary tags (key-value pairs) to associate with the usage plan.
	Tags []UsagePlanTag `pulumi:"tags"`
	// Configures the overall request rate (average requests per second) and burst capacity.
	Throttle *UsagePlanThrottleSettings `pulumi:"throttle"`
	// A name for the 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)

Resource Type definition for AWS::ApiGateway::UsagePlan

type LookupUsagePlanResultOutput added in v0.12.0

type LookupUsagePlanResultOutput struct{ *pulumi.OutputState }

func LookupUsagePlanOutput added in v0.12.0

func (LookupUsagePlanResultOutput) ApiStages added in v0.12.0

The API stages to associate with this usage plan.

func (LookupUsagePlanResultOutput) Description added in v0.12.0

A description of the usage plan.

func (LookupUsagePlanResultOutput) ElementType added in v0.12.0

func (LookupUsagePlanResultOutput) Id added in v0.12.0

The provider-assigned unique ID for this managed resource.

func (LookupUsagePlanResultOutput) Quota added in v0.12.0

Configures the number of requests that users can make within a given interval.

func (LookupUsagePlanResultOutput) Tags added in v0.12.0

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

func (LookupUsagePlanResultOutput) Throttle added in v0.12.0

Configures the overall request rate (average requests per second) and burst capacity.

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) ToOutput added in v0.76.0

func (LookupUsagePlanResultOutput) UsagePlanName added in v0.12.0

A name for the 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 []VpcLinkTag `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

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

A name for the VPC link.

func (LookupVpcLinkResultOutput) Tags added in v0.12.0

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) ToOutput added in v0.76.0

func (LookupVpcLinkResultOutput) VpcLinkId added in v0.52.0

The ID of the instance that backs VPC link.

type Method

type Method struct {
	pulumi.CustomResourceState

	// Indicates whether the method requires clients to submit a valid API key.
	ApiKeyRequired pulumi.BoolPtrOutput `pulumi:"apiKeyRequired"`
	// A list of authorization scopes configured on the method.
	AuthorizationScopes pulumi.StringArrayOutput `pulumi:"authorizationScopes"`
	// The method's authorization type.
	AuthorizationType MethodAuthorizationTypePtrOutput `pulumi:"authorizationType"`
	// The identifier of the authorizer to use on this method.
	AuthorizerId pulumi.StringPtrOutput `pulumi:"authorizerId"`
	// The backend system that the method calls when it receives a request.
	HttpMethod pulumi.StringOutput `pulumi:"httpMethod"`
	// The backend system that the method calls when it receives a request.
	Integration MethodIntegrationPtrOutput `pulumi:"integration"`
	// The responses that can be sent to the client who calls the method.
	MethodResponses MethodResponseArrayOutput `pulumi:"methodResponses"`
	// A friendly operation name for the method.
	OperationName pulumi.StringPtrOutput `pulumi:"operationName"`
	// The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
	RequestModels pulumi.AnyOutput `pulumi:"requestModels"`
	// The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
	RequestParameters pulumi.AnyOutput `pulumi:"requestParameters"`
	// The ID of the associated request validator.
	RequestValidatorId pulumi.StringPtrOutput `pulumi:"requestValidatorId"`
	// The ID of an API Gateway resource.
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// The ID of the RestApi resource in which API Gateway creates the method.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
}

Resource Type definition for AWS::ApiGateway::Method

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

func (*Method) ToOutput added in v0.76.0

func (i *Method) ToOutput(ctx context.Context) pulumix.Output[*Method]

type MethodArgs

type MethodArgs struct {
	// Indicates whether the method requires clients to submit a valid API key.
	ApiKeyRequired pulumi.BoolPtrInput
	// A list of authorization scopes configured on the method.
	AuthorizationScopes pulumi.StringArrayInput
	// The method's authorization type.
	AuthorizationType MethodAuthorizationTypePtrInput
	// The identifier of the authorizer to use on this method.
	AuthorizerId pulumi.StringPtrInput
	// The backend system that the method calls when it receives a request.
	HttpMethod pulumi.StringInput
	// The backend system that the method calls when it receives a request.
	Integration MethodIntegrationPtrInput
	// The responses that can be sent to the client who calls the method.
	MethodResponses MethodResponseArrayInput
	// A friendly operation name for the method.
	OperationName pulumi.StringPtrInput
	// The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
	RequestModels pulumi.Input
	// The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
	RequestParameters pulumi.Input
	// The ID of the associated request validator.
	RequestValidatorId pulumi.StringPtrInput
	// The ID of an API Gateway resource.
	ResourceId pulumi.StringInput
	// The ID of the RestApi resource in which API Gateway creates the method.
	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.

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 MethodAuthorizationTypeArgs and MethodAuthorizationTypeOutput values. You can construct a concrete instance of `MethodAuthorizationTypeInput` via:

MethodAuthorizationTypeArgs{...}

type MethodAuthorizationTypeOutput added in v0.2.0

type MethodAuthorizationTypeOutput struct{ *pulumi.OutputState }

func (MethodAuthorizationTypeOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodAuthorizationTypeOutput) ToStringOutput added in v0.2.0

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 (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 (MethodAuthorizationTypePtrOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodAuthorizationTypePtrOutput) ToStringPtrOutput added in v0.2.0

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.
	CacheKeyParameters []string `pulumi:"cacheKeyParameters"`
	// An API-specific tag group of related cached parameters.
	CacheNamespace *string `pulumi:"cacheNamespace"`
	// The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
	ConnectionId *string `pulumi:"connectionId"`
	// The type of the network connection to the integration endpoint.
	ConnectionType *MethodIntegrationConnectionType `pulumi:"connectionType"`
	// Specifies how to handle request payload content type conversions.
	ContentHandling *MethodIntegrationContentHandling `pulumi:"contentHandling"`
	// The credentials that are required for the integration.
	Credentials *string `pulumi:"credentials"`
	// The integration's HTTP method type.
	IntegrationHttpMethod *string `pulumi:"integrationHttpMethod"`
	// The response that API Gateway provides after a method's backend completes processing a request.
	IntegrationResponses []MethodIntegrationResponse `pulumi:"integrationResponses"`
	// Indicates when API Gateway passes requests to the targeted backend.
	PassthroughBehavior *MethodIntegrationPassthroughBehavior `pulumi:"passthroughBehavior"`
	// The request parameters that API Gateway sends with the backend request.
	RequestParameters interface{} `pulumi:"requestParameters"`
	// A map of Apache Velocity templates that are applied on the request payload.
	RequestTemplates interface{} `pulumi:"requestTemplates"`
	// Custom timeout between 50 and 29,000 milliseconds.
	TimeoutInMillis *int `pulumi:"timeoutInMillis"`
	// The type of backend that your method is running.
	Type MethodIntegrationType `pulumi:"type"`
	// The Uniform Resource Identifier (URI) for the integration.
	Uri *string `pulumi:"uri"`
}

type MethodIntegrationArgs

type MethodIntegrationArgs struct {
	// A list of request parameters whose values API Gateway caches.
	CacheKeyParameters pulumi.StringArrayInput `pulumi:"cacheKeyParameters"`
	// An API-specific tag group of related cached parameters.
	CacheNamespace pulumi.StringPtrInput `pulumi:"cacheNamespace"`
	// The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
	ConnectionId pulumi.StringPtrInput `pulumi:"connectionId"`
	// The type of the network connection to the integration endpoint.
	ConnectionType MethodIntegrationConnectionTypePtrInput `pulumi:"connectionType"`
	// Specifies how to handle request payload content type conversions.
	ContentHandling MethodIntegrationContentHandlingPtrInput `pulumi:"contentHandling"`
	// The credentials that are required for the integration.
	Credentials pulumi.StringPtrInput `pulumi:"credentials"`
	// The integration's HTTP method type.
	IntegrationHttpMethod pulumi.StringPtrInput `pulumi:"integrationHttpMethod"`
	// The response that API Gateway provides after a method's backend completes processing a request.
	IntegrationResponses MethodIntegrationResponseArrayInput `pulumi:"integrationResponses"`
	// Indicates when API Gateway passes requests to the targeted backend.
	PassthroughBehavior MethodIntegrationPassthroughBehaviorPtrInput `pulumi:"passthroughBehavior"`
	// The request parameters that API Gateway sends with the backend request.
	RequestParameters pulumi.Input `pulumi:"requestParameters"`
	// A map of Apache Velocity templates that are applied on the request payload.
	RequestTemplates pulumi.Input `pulumi:"requestTemplates"`
	// Custom timeout between 50 and 29,000 milliseconds.
	TimeoutInMillis pulumi.IntPtrInput `pulumi:"timeoutInMillis"`
	// The type of backend that your method is running.
	Type MethodIntegrationTypeInput `pulumi:"type"`
	// The Uniform Resource Identifier (URI) for the integration.
	Uri pulumi.StringPtrInput `pulumi:"uri"`
}

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

func (MethodIntegrationArgs) ToOutput added in v0.76.0

type MethodIntegrationConnectionType added in v0.2.0

type MethodIntegrationConnectionType string

The type of the network connection to the integration endpoint.

func (MethodIntegrationConnectionType) ElementType added in v0.2.0

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 (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 (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 MethodIntegrationConnectionTypeArgs and MethodIntegrationConnectionTypeOutput values. You can construct a concrete instance of `MethodIntegrationConnectionTypeInput` via:

MethodIntegrationConnectionTypeArgs{...}

type MethodIntegrationConnectionTypeOutput added in v0.2.0

type MethodIntegrationConnectionTypeOutput struct{ *pulumi.OutputState }

func (MethodIntegrationConnectionTypeOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodIntegrationConnectionTypeOutput) ToStringOutput added in v0.2.0

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 (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 (MethodIntegrationConnectionTypePtrOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodIntegrationConnectionTypePtrOutput) ToStringPtrOutput added in v0.2.0

func (MethodIntegrationConnectionTypePtrOutput) ToStringPtrOutputWithContext added in v0.2.0

type MethodIntegrationContentHandling added in v0.2.0

type MethodIntegrationContentHandling string

Specifies how to handle request payload content type conversions.

func (MethodIntegrationContentHandling) ElementType added in v0.2.0

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 (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 (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 MethodIntegrationContentHandlingArgs and MethodIntegrationContentHandlingOutput values. You can construct a concrete instance of `MethodIntegrationContentHandlingInput` via:

MethodIntegrationContentHandlingArgs{...}

type MethodIntegrationContentHandlingOutput added in v0.2.0

type MethodIntegrationContentHandlingOutput struct{ *pulumi.OutputState }

func (MethodIntegrationContentHandlingOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodIntegrationContentHandlingOutput) ToStringOutput added in v0.2.0

func (MethodIntegrationContentHandlingOutput) ToStringOutputWithContext added in v0.2.0

func (MethodIntegrationContentHandlingOutput) ToStringPtrOutput added in v0.2.0

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 (MethodIntegrationContentHandlingPtrOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodIntegrationContentHandlingPtrOutput) ToStringPtrOutput added in v0.2.0

func (MethodIntegrationContentHandlingPtrOutput) ToStringPtrOutputWithContext added in v0.2.0

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 }

func (MethodIntegrationOutput) CacheKeyParameters

func (o MethodIntegrationOutput) CacheKeyParameters() pulumi.StringArrayOutput

A list of request parameters whose values API Gateway caches.

func (MethodIntegrationOutput) CacheNamespace

func (o MethodIntegrationOutput) CacheNamespace() pulumi.StringPtrOutput

An API-specific tag group of related cached parameters.

func (MethodIntegrationOutput) ConnectionId

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

func (MethodIntegrationOutput) ConnectionType

The type of the network connection to the integration endpoint.

func (MethodIntegrationOutput) ContentHandling

Specifies how to handle request payload content type conversions.

func (MethodIntegrationOutput) Credentials

The credentials that are required for the integration.

func (MethodIntegrationOutput) ElementType

func (MethodIntegrationOutput) ElementType() reflect.Type

func (MethodIntegrationOutput) IntegrationHttpMethod

func (o MethodIntegrationOutput) IntegrationHttpMethod() pulumi.StringPtrOutput

The integration's HTTP method type.

func (MethodIntegrationOutput) IntegrationResponses

The response that API Gateway provides after a method's backend completes processing a request.

func (MethodIntegrationOutput) PassthroughBehavior

Indicates when API Gateway passes requests to the targeted backend.

func (MethodIntegrationOutput) RequestParameters

func (o MethodIntegrationOutput) RequestParameters() pulumi.AnyOutput

The request parameters that API Gateway sends with the backend request.

func (MethodIntegrationOutput) RequestTemplates

func (o MethodIntegrationOutput) RequestTemplates() pulumi.AnyOutput

A map of Apache Velocity templates that are applied on the request payload.

func (MethodIntegrationOutput) TimeoutInMillis

func (o MethodIntegrationOutput) TimeoutInMillis() pulumi.IntPtrOutput

Custom timeout between 50 and 29,000 milliseconds.

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) ToOutput added in v0.76.0

func (MethodIntegrationOutput) Type

The type of backend that your method is running.

func (MethodIntegrationOutput) Uri

The Uniform Resource Identifier (URI) for the integration.

type MethodIntegrationPassthroughBehavior added in v0.2.0

type MethodIntegrationPassthroughBehavior string

Indicates when API Gateway passes requests to the targeted backend.

func (MethodIntegrationPassthroughBehavior) ElementType added in v0.2.0

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 (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 (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 MethodIntegrationPassthroughBehaviorArgs and MethodIntegrationPassthroughBehaviorOutput values. You can construct a concrete instance of `MethodIntegrationPassthroughBehaviorInput` via:

MethodIntegrationPassthroughBehaviorArgs{...}

type MethodIntegrationPassthroughBehaviorOutput added in v0.2.0

type MethodIntegrationPassthroughBehaviorOutput struct{ *pulumi.OutputState }

func (MethodIntegrationPassthroughBehaviorOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodIntegrationPassthroughBehaviorOutput) ToStringOutput added in v0.2.0

func (MethodIntegrationPassthroughBehaviorOutput) ToStringOutputWithContext added in v0.2.0

func (MethodIntegrationPassthroughBehaviorOutput) ToStringPtrOutput added in v0.2.0

func (MethodIntegrationPassthroughBehaviorOutput) ToStringPtrOutputWithContext added in v0.2.0

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 (MethodIntegrationPassthroughBehaviorPtrOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodIntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutput added in v0.2.0

func (MethodIntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutputWithContext added in v0.2.0

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

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.

func (MethodIntegrationPtrOutput) CacheNamespace

An API-specific tag group of related cached parameters.

func (MethodIntegrationPtrOutput) ConnectionId

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

func (MethodIntegrationPtrOutput) ConnectionType

The type of the network connection to the integration endpoint.

func (MethodIntegrationPtrOutput) ContentHandling

Specifies how to handle request payload content type conversions.

func (MethodIntegrationPtrOutput) Credentials

The credentials that are required for the integration.

func (MethodIntegrationPtrOutput) Elem

func (MethodIntegrationPtrOutput) ElementType

func (MethodIntegrationPtrOutput) ElementType() reflect.Type

func (MethodIntegrationPtrOutput) IntegrationHttpMethod

func (o MethodIntegrationPtrOutput) IntegrationHttpMethod() pulumi.StringPtrOutput

The integration's HTTP method type.

func (MethodIntegrationPtrOutput) IntegrationResponses

The response that API Gateway provides after a method's backend completes processing a request.

func (MethodIntegrationPtrOutput) PassthroughBehavior

Indicates when API Gateway passes requests to the targeted backend.

func (MethodIntegrationPtrOutput) RequestParameters

func (o MethodIntegrationPtrOutput) RequestParameters() pulumi.AnyOutput

The request parameters that API Gateway sends with the backend request.

func (MethodIntegrationPtrOutput) RequestTemplates

func (o MethodIntegrationPtrOutput) RequestTemplates() pulumi.AnyOutput

A map of Apache Velocity templates that are applied on the request payload.

func (MethodIntegrationPtrOutput) TimeoutInMillis

func (o MethodIntegrationPtrOutput) TimeoutInMillis() pulumi.IntPtrOutput

Custom timeout between 50 and 29,000 milliseconds.

func (MethodIntegrationPtrOutput) ToMethodIntegrationPtrOutput

func (o MethodIntegrationPtrOutput) ToMethodIntegrationPtrOutput() MethodIntegrationPtrOutput

func (MethodIntegrationPtrOutput) ToMethodIntegrationPtrOutputWithContext

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

func (MethodIntegrationPtrOutput) ToOutput added in v0.76.0

func (MethodIntegrationPtrOutput) Type

The type of backend that your method is running.

func (MethodIntegrationPtrOutput) Uri

The Uniform Resource Identifier (URI) for the integration.

type MethodIntegrationResponse

type MethodIntegrationResponse struct {
	// Specifies how to handle request payload content type conversions.
	ContentHandling *MethodIntegrationResponseContentHandling `pulumi:"contentHandling"`
	// The response parameters from the backend response that API Gateway sends to the method response.
	ResponseParameters interface{} `pulumi:"responseParameters"`
	// The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.
	ResponseTemplates interface{} `pulumi:"responseTemplates"`
	// A regular expression that specifies which error strings or status codes from the backend map to the integration response.
	SelectionPattern *string `pulumi:"selectionPattern"`
	// The status code that API Gateway uses to map the integration response to a MethodResponse status code.
	StatusCode string `pulumi:"statusCode"`
}

type MethodIntegrationResponseArgs

type MethodIntegrationResponseArgs struct {
	// Specifies how to handle request payload content type conversions.
	ContentHandling MethodIntegrationResponseContentHandlingPtrInput `pulumi:"contentHandling"`
	// The response parameters from the backend response that API Gateway sends to the method response.
	ResponseParameters pulumi.Input `pulumi:"responseParameters"`
	// The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.
	ResponseTemplates pulumi.Input `pulumi:"responseTemplates"`
	// A regular expression that specifies which error strings or status codes from the backend map to the integration response.
	SelectionPattern pulumi.StringPtrInput `pulumi:"selectionPattern"`
	// The status code that API Gateway uses to map the integration response to a MethodResponse status code.
	StatusCode pulumi.StringInput `pulumi:"statusCode"`
}

func (MethodIntegrationResponseArgs) ElementType

func (MethodIntegrationResponseArgs) ToMethodIntegrationResponseOutput

func (i MethodIntegrationResponseArgs) ToMethodIntegrationResponseOutput() MethodIntegrationResponseOutput

func (MethodIntegrationResponseArgs) ToMethodIntegrationResponseOutputWithContext

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

func (MethodIntegrationResponseArgs) ToOutput added in v0.76.0

type MethodIntegrationResponseArray

type MethodIntegrationResponseArray []MethodIntegrationResponseInput

func (MethodIntegrationResponseArray) ElementType

func (MethodIntegrationResponseArray) ToMethodIntegrationResponseArrayOutput

func (i MethodIntegrationResponseArray) ToMethodIntegrationResponseArrayOutput() MethodIntegrationResponseArrayOutput

func (MethodIntegrationResponseArray) ToMethodIntegrationResponseArrayOutputWithContext

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

func (MethodIntegrationResponseArray) ToOutput added in v0.76.0

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) Index

func (MethodIntegrationResponseArrayOutput) ToMethodIntegrationResponseArrayOutput

func (o MethodIntegrationResponseArrayOutput) ToMethodIntegrationResponseArrayOutput() MethodIntegrationResponseArrayOutput

func (MethodIntegrationResponseArrayOutput) ToMethodIntegrationResponseArrayOutputWithContext

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

func (MethodIntegrationResponseArrayOutput) ToOutput added in v0.76.0

type MethodIntegrationResponseContentHandling added in v0.2.0

type MethodIntegrationResponseContentHandling string

Specifies how to handle request payload content type conversions.

func (MethodIntegrationResponseContentHandling) ElementType added in v0.2.0

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 (MethodIntegrationResponseContentHandling) ToStringOutputWithContext added in v0.2.0

func (MethodIntegrationResponseContentHandling) ToStringPtrOutput added in v0.2.0

func (MethodIntegrationResponseContentHandling) ToStringPtrOutputWithContext added in v0.2.0

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 MethodIntegrationResponseContentHandlingArgs and MethodIntegrationResponseContentHandlingOutput values. You can construct a concrete instance of `MethodIntegrationResponseContentHandlingInput` via:

MethodIntegrationResponseContentHandlingArgs{...}

type MethodIntegrationResponseContentHandlingOutput added in v0.2.0

type MethodIntegrationResponseContentHandlingOutput struct{ *pulumi.OutputState }

func (MethodIntegrationResponseContentHandlingOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodIntegrationResponseContentHandlingOutput) ToStringOutput added in v0.2.0

func (MethodIntegrationResponseContentHandlingOutput) ToStringOutputWithContext added in v0.2.0

func (MethodIntegrationResponseContentHandlingOutput) ToStringPtrOutput added in v0.2.0

func (MethodIntegrationResponseContentHandlingOutput) ToStringPtrOutputWithContext added in v0.2.0

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 (MethodIntegrationResponseContentHandlingPtrOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodIntegrationResponseContentHandlingPtrOutput) ToStringPtrOutput added in v0.2.0

func (MethodIntegrationResponseContentHandlingPtrOutput) ToStringPtrOutputWithContext added in v0.2.0

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 }

func (MethodIntegrationResponseOutput) ContentHandling

Specifies how to handle request payload content type conversions.

func (MethodIntegrationResponseOutput) ElementType

func (MethodIntegrationResponseOutput) ResponseParameters

func (o MethodIntegrationResponseOutput) ResponseParameters() pulumi.AnyOutput

The response parameters from the backend response that API Gateway sends to the method response.

func (MethodIntegrationResponseOutput) ResponseTemplates

func (o MethodIntegrationResponseOutput) ResponseTemplates() pulumi.AnyOutput

The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.

func (MethodIntegrationResponseOutput) SelectionPattern

A regular expression that specifies which error strings or status codes from the backend map to the integration response.

func (MethodIntegrationResponseOutput) StatusCode

The status code that API Gateway uses to map the integration response to a MethodResponse status code.

func (MethodIntegrationResponseOutput) ToMethodIntegrationResponseOutput

func (o MethodIntegrationResponseOutput) ToMethodIntegrationResponseOutput() MethodIntegrationResponseOutput

func (MethodIntegrationResponseOutput) ToMethodIntegrationResponseOutputWithContext

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

func (MethodIntegrationResponseOutput) ToOutput added in v0.76.0

type MethodIntegrationType added in v0.2.0

type MethodIntegrationType string

The type of backend that your method is running.

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 MethodIntegrationTypeArgs and MethodIntegrationTypeOutput values. You can construct a concrete instance of `MethodIntegrationTypeInput` via:

MethodIntegrationTypeArgs{...}

type MethodIntegrationTypeOutput added in v0.2.0

type MethodIntegrationTypeOutput struct{ *pulumi.OutputState }

func (MethodIntegrationTypeOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

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 (MethodIntegrationTypePtrOutput) ElementType added in v0.2.0

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) ToOutput added in v0.76.0

func (MethodIntegrationTypePtrOutput) ToStringPtrOutput added in v0.2.0

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

Indicates whether the method requires clients to submit a valid API key.

func (MethodOutput) AuthorizationScopes added in v0.17.0

func (o MethodOutput) AuthorizationScopes() pulumi.StringArrayOutput

A list of authorization scopes configured on the method.

func (MethodOutput) AuthorizationType added in v0.17.0

func (o MethodOutput) AuthorizationType() MethodAuthorizationTypePtrOutput

The method's authorization type.

func (MethodOutput) AuthorizerId added in v0.17.0

func (o MethodOutput) AuthorizerId() pulumi.StringPtrOutput

The identifier of the authorizer to use on this method.

func (MethodOutput) ElementType

func (MethodOutput) ElementType() reflect.Type

func (MethodOutput) HttpMethod added in v0.17.0

func (o MethodOutput) HttpMethod() pulumi.StringOutput

The backend system that the method calls when it receives a request.

func (MethodOutput) Integration added in v0.17.0

func (o MethodOutput) Integration() MethodIntegrationPtrOutput

The backend system that the method calls when it receives a request.

func (MethodOutput) MethodResponses added in v0.17.0

func (o MethodOutput) MethodResponses() MethodResponseArrayOutput

The responses that can be sent to the client who calls the method.

func (MethodOutput) OperationName added in v0.17.0

func (o MethodOutput) OperationName() pulumi.StringPtrOutput

A friendly operation name for the method.

func (MethodOutput) RequestModels added in v0.17.0

func (o MethodOutput) RequestModels() pulumi.AnyOutput

The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.

func (MethodOutput) RequestParameters added in v0.17.0

func (o MethodOutput) RequestParameters() pulumi.AnyOutput

The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.

func (MethodOutput) RequestValidatorId added in v0.17.0

func (o MethodOutput) RequestValidatorId() pulumi.StringPtrOutput

The ID of the associated request validator.

func (MethodOutput) ResourceId added in v0.17.0

func (o MethodOutput) ResourceId() pulumi.StringOutput

The ID of an API Gateway resource.

func (MethodOutput) RestApiId added in v0.17.0

func (o MethodOutput) RestApiId() pulumi.StringOutput

The ID of the RestApi resource in which API Gateway creates the method.

func (MethodOutput) ToMethodOutput

func (o MethodOutput) ToMethodOutput() MethodOutput

func (MethodOutput) ToMethodOutputWithContext

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

func (MethodOutput) ToOutput added in v0.76.0

func (o MethodOutput) ToOutput(ctx context.Context) pulumix.Output[*Method]

type MethodResponse added in v0.2.0

type MethodResponse struct {
	// The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
	ResponseModels interface{} `pulumi:"responseModels"`
	// Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.
	ResponseParameters interface{} `pulumi:"responseParameters"`
	// The method response's status code, which you map to an IntegrationResponse.
	StatusCode string `pulumi:"statusCode"`
}

type MethodResponseArgs added in v0.2.0

type MethodResponseArgs struct {
	// The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
	ResponseModels pulumi.Input `pulumi:"responseModels"`
	// Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.
	ResponseParameters pulumi.Input `pulumi:"responseParameters"`
	// The method response's status code, which you map to an IntegrationResponse.
	StatusCode pulumi.StringInput `pulumi:"statusCode"`
}

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

func (MethodResponseArgs) ToOutput added in v0.76.0

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

func (MethodResponseArray) ToOutput added in v0.76.0

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 (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

func (MethodResponseArrayOutput) ToOutput added in v0.76.0

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 }

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

The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

func (MethodResponseOutput) ResponseParameters added in v0.2.0

func (o MethodResponseOutput) ResponseParameters() pulumi.AnyOutput

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

func (MethodResponseOutput) StatusCode added in v0.2.0

func (o MethodResponseOutput) StatusCode() pulumi.StringOutput

The method response's status code, which you map to an IntegrationResponse.

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

func (MethodResponseOutput) ToOutput added in v0.76.0

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"`
	// A description that identifies this model.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// The ID of a REST API with which to associate this model.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
	Schema pulumi.AnyOutput `pulumi:"schema"`
}

Resource Type definition for AWS::ApiGateway::Model

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

func (*Model) ToOutput added in v0.76.0

func (i *Model) ToOutput(ctx context.Context) pulumix.Output[*Model]

type ModelArgs

type ModelArgs struct {
	// The content type for the model.
	ContentType pulumi.StringPtrInput
	// A description that identifies this model.
	Description pulumi.StringPtrInput
	// A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
	Name pulumi.StringPtrInput
	// The ID of a REST API with which to associate this model.
	RestApiId pulumi.StringInput
	// The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
	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

A description that identifies this model.

func (ModelOutput) ElementType

func (ModelOutput) ElementType() reflect.Type

func (ModelOutput) Name added in v0.17.0

A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.

func (ModelOutput) RestApiId added in v0.17.0

func (o ModelOutput) RestApiId() pulumi.StringOutput

The ID of a REST API with which to associate this model.

func (ModelOutput) Schema added in v0.17.0

func (o ModelOutput) Schema() pulumi.AnyOutput

The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.

func (ModelOutput) ToModelOutput

func (o ModelOutput) ToModelOutput() ModelOutput

func (ModelOutput) ToModelOutputWithContext

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

func (ModelOutput) ToOutput added in v0.76.0

func (o ModelOutput) ToOutput(ctx context.Context) pulumix.Output[*Model]

type ModelState

type ModelState struct {
}

func (ModelState) ElementType

func (ModelState) ElementType() reflect.Type

type RequestValidator

type RequestValidator struct {
	pulumi.CustomResourceState

	// Name of the request validator.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// ID of the request validator.
	RequestValidatorId pulumi.StringOutput `pulumi:"requestValidatorId"`
	// The identifier of the targeted API entity.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// Indicates whether to validate the request body according to the configured schema for the targeted API and method.
	ValidateRequestBody pulumi.BoolPtrOutput `pulumi:"validateRequestBody"`
	// Indicates whether to validate request parameters.
	ValidateRequestParameters pulumi.BoolPtrOutput `pulumi:"validateRequestParameters"`
}

Resource Type definition for AWS::ApiGateway::RequestValidator

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) ToOutput added in v0.76.0

func (*RequestValidator) ToRequestValidatorOutput

func (i *RequestValidator) ToRequestValidatorOutput() RequestValidatorOutput

func (*RequestValidator) ToRequestValidatorOutputWithContext

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

type RequestValidatorArgs

type RequestValidatorArgs struct {
	// Name of the request validator.
	Name pulumi.StringPtrInput
	// The identifier of the targeted API entity.
	RestApiId pulumi.StringInput
	// Indicates whether to validate the request body according to the configured schema for the targeted API and method.
	ValidateRequestBody pulumi.BoolPtrInput
	// Indicates whether to validate request parameters.
	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

Name of the request validator.

func (RequestValidatorOutput) RequestValidatorId added in v0.17.0

func (o RequestValidatorOutput) RequestValidatorId() pulumi.StringOutput

ID of the request validator.

func (RequestValidatorOutput) RestApiId added in v0.17.0

The identifier of the targeted API entity.

func (RequestValidatorOutput) ToOutput added in v0.76.0

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

Indicates whether to validate the request body according to the configured schema for the targeted API and method.

func (RequestValidatorOutput) ValidateRequestParameters added in v0.17.0

func (o RequestValidatorOutput) ValidateRequestParameters() pulumi.BoolPtrOutput

Indicates whether to validate request parameters.

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"`
	// A unique primary identifier for a Resource
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// The ID of the RestApi resource in which you want to create this resource..
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
}

Resource Type definition for AWS::ApiGateway::Resource

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) ToOutput added in v0.76.0

func (i *Resource) ToOutput(ctx context.Context) pulumix.Output[*Resource]

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 ID of the RestApi resource in which you want to create this resource..
	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

A unique primary identifier for a Resource

func (ResourceOutput) RestApiId added in v0.17.0

func (o ResourceOutput) RestApiId() pulumi.StringOutput

The ID of the RestApi resource in which you want to create this resource..

func (ResourceOutput) ToOutput added in v0.76.0

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

	ApiKeySourceType          pulumi.StringPtrOutput                `pulumi:"apiKeySourceType"`
	BinaryMediaTypes          pulumi.StringArrayOutput              `pulumi:"binaryMediaTypes"`
	Body                      pulumi.AnyOutput                      `pulumi:"body"`
	BodyS3Location            RestApiS3LocationPtrOutput            `pulumi:"bodyS3Location"`
	CloneFrom                 pulumi.StringPtrOutput                `pulumi:"cloneFrom"`
	Description               pulumi.StringPtrOutput                `pulumi:"description"`
	DisableExecuteApiEndpoint pulumi.BoolPtrOutput                  `pulumi:"disableExecuteApiEndpoint"`
	EndpointConfiguration     RestApiEndpointConfigurationPtrOutput `pulumi:"endpointConfiguration"`
	FailOnWarnings            pulumi.BoolPtrOutput                  `pulumi:"failOnWarnings"`
	MinimumCompressionSize    pulumi.IntPtrOutput                   `pulumi:"minimumCompressionSize"`
	Mode                      pulumi.StringPtrOutput                `pulumi:"mode"`
	Name                      pulumi.StringPtrOutput                `pulumi:"name"`
	Parameters                pulumi.AnyOutput                      `pulumi:"parameters"`
	Policy                    pulumi.AnyOutput                      `pulumi:"policy"`
	RestApiId                 pulumi.StringOutput                   `pulumi:"restApiId"`
	RootResourceId            pulumi.StringOutput                   `pulumi:"rootResourceId"`
	Tags                      RestApiTagArrayOutput                 `pulumi:"tags"`
}

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

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) ToOutput added in v0.76.0

func (i *RestApi) ToOutput(ctx context.Context) pulumix.Output[*RestApi]

func (*RestApi) ToRestApiOutput

func (i *RestApi) ToRestApiOutput() RestApiOutput

func (*RestApi) ToRestApiOutputWithContext

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

type RestApiArgs

type RestApiArgs struct {
	ApiKeySourceType          pulumi.StringPtrInput
	BinaryMediaTypes          pulumi.StringArrayInput
	Body                      pulumi.Input
	BodyS3Location            RestApiS3LocationPtrInput
	CloneFrom                 pulumi.StringPtrInput
	Description               pulumi.StringPtrInput
	DisableExecuteApiEndpoint pulumi.BoolPtrInput
	EndpointConfiguration     RestApiEndpointConfigurationPtrInput
	FailOnWarnings            pulumi.BoolPtrInput
	MinimumCompressionSize    pulumi.IntPtrInput
	Mode                      pulumi.StringPtrInput
	Name                      pulumi.StringPtrInput
	Parameters                pulumi.Input
	Policy                    pulumi.Input
	Tags                      RestApiTagArrayInput
}

The set of arguments for constructing a RestApi resource.

func (RestApiArgs) ElementType

func (RestApiArgs) ElementType() reflect.Type

type RestApiEndpointConfiguration

type RestApiEndpointConfiguration struct {
	Types          []string `pulumi:"types"`
	VpcEndpointIds []string `pulumi:"vpcEndpointIds"`
}

type RestApiEndpointConfigurationArgs

type RestApiEndpointConfigurationArgs struct {
	Types          pulumi.StringArrayInput `pulumi:"types"`
	VpcEndpointIds pulumi.StringArrayInput `pulumi:"vpcEndpointIds"`
}

func (RestApiEndpointConfigurationArgs) ElementType

func (RestApiEndpointConfigurationArgs) ToOutput added in v0.76.0

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 }

func (RestApiEndpointConfigurationOutput) ElementType

func (RestApiEndpointConfigurationOutput) ToOutput added in v0.76.0

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 (RestApiEndpointConfigurationOutput) VpcEndpointIds

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

type RestApiEndpointConfigurationPtrOutput

type RestApiEndpointConfigurationPtrOutput struct{ *pulumi.OutputState }

func (RestApiEndpointConfigurationPtrOutput) Elem

func (RestApiEndpointConfigurationPtrOutput) ElementType

func (RestApiEndpointConfigurationPtrOutput) ToOutput added in v0.76.0

func (RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutput

func (o RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutput() RestApiEndpointConfigurationPtrOutput

func (RestApiEndpointConfigurationPtrOutput) ToRestApiEndpointConfigurationPtrOutputWithContext

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

func (RestApiEndpointConfigurationPtrOutput) Types

func (RestApiEndpointConfigurationPtrOutput) VpcEndpointIds

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

func (RestApiOutput) BinaryMediaTypes added in v0.17.0

func (o RestApiOutput) BinaryMediaTypes() pulumi.StringArrayOutput

func (RestApiOutput) Body added in v0.17.0

func (o RestApiOutput) Body() pulumi.AnyOutput

func (RestApiOutput) BodyS3Location added in v0.17.0

func (o RestApiOutput) BodyS3Location() RestApiS3LocationPtrOutput

func (RestApiOutput) CloneFrom added in v0.17.0

func (o RestApiOutput) CloneFrom() pulumi.StringPtrOutput

func (RestApiOutput) Description added in v0.17.0

func (o RestApiOutput) Description() pulumi.StringPtrOutput

func (RestApiOutput) DisableExecuteApiEndpoint added in v0.17.0

func (o RestApiOutput) DisableExecuteApiEndpoint() pulumi.BoolPtrOutput

func (RestApiOutput) ElementType

func (RestApiOutput) ElementType() reflect.Type

func (RestApiOutput) EndpointConfiguration added in v0.17.0

func (o RestApiOutput) EndpointConfiguration() RestApiEndpointConfigurationPtrOutput

func (RestApiOutput) FailOnWarnings added in v0.17.0

func (o RestApiOutput) FailOnWarnings() pulumi.BoolPtrOutput

func (RestApiOutput) MinimumCompressionSize added in v0.17.0

func (o RestApiOutput) MinimumCompressionSize() pulumi.IntPtrOutput

func (RestApiOutput) Mode added in v0.17.0

func (RestApiOutput) Name added in v0.17.0

func (RestApiOutput) Parameters added in v0.17.0

func (o RestApiOutput) Parameters() pulumi.AnyOutput

func (RestApiOutput) Policy added in v0.17.0

func (o RestApiOutput) Policy() pulumi.AnyOutput

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 (RestApiOutput) ToOutput added in v0.76.0

func (o RestApiOutput) ToOutput(ctx context.Context) pulumix.Output[*RestApi]

func (RestApiOutput) ToRestApiOutput

func (o RestApiOutput) ToRestApiOutput() RestApiOutput

func (RestApiOutput) ToRestApiOutputWithContext

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

type RestApiS3Location

type RestApiS3Location struct {
	Bucket  *string `pulumi:"bucket"`
	ETag    *string `pulumi:"eTag"`
	Key     *string `pulumi:"key"`
	Version *string `pulumi:"version"`
}

type RestApiS3LocationArgs

type RestApiS3LocationArgs struct {
	Bucket  pulumi.StringPtrInput `pulumi:"bucket"`
	ETag    pulumi.StringPtrInput `pulumi:"eTag"`
	Key     pulumi.StringPtrInput `pulumi:"key"`
	Version pulumi.StringPtrInput `pulumi:"version"`
}

func (RestApiS3LocationArgs) ElementType

func (RestApiS3LocationArgs) ElementType() reflect.Type

func (RestApiS3LocationArgs) ToOutput added in v0.76.0

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 }

func (RestApiS3LocationOutput) Bucket

func (RestApiS3LocationOutput) ETag

func (RestApiS3LocationOutput) ElementType

func (RestApiS3LocationOutput) ElementType() reflect.Type

func (RestApiS3LocationOutput) Key

func (RestApiS3LocationOutput) ToOutput added in v0.76.0

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

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

type RestApiS3LocationPtrOutput

type RestApiS3LocationPtrOutput struct{ *pulumi.OutputState }

func (RestApiS3LocationPtrOutput) Bucket

func (RestApiS3LocationPtrOutput) ETag

func (RestApiS3LocationPtrOutput) Elem

func (RestApiS3LocationPtrOutput) ElementType

func (RestApiS3LocationPtrOutput) ElementType() reflect.Type

func (RestApiS3LocationPtrOutput) Key

func (RestApiS3LocationPtrOutput) ToOutput added in v0.76.0

func (RestApiS3LocationPtrOutput) ToRestApiS3LocationPtrOutput

func (o RestApiS3LocationPtrOutput) ToRestApiS3LocationPtrOutput() RestApiS3LocationPtrOutput

func (RestApiS3LocationPtrOutput) ToRestApiS3LocationPtrOutputWithContext

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

func (RestApiS3LocationPtrOutput) Version

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 RestApiTagArgs

type RestApiTagArgs struct {
	Key   pulumi.StringInput `pulumi:"key"`
	Value pulumi.StringInput `pulumi:"value"`
}

func (RestApiTagArgs) ElementType

func (RestApiTagArgs) ElementType() reflect.Type

func (RestApiTagArgs) ToOutput added in v0.76.0

func (RestApiTagArgs) ToRestApiTagOutput

func (i RestApiTagArgs) ToRestApiTagOutput() RestApiTagOutput

func (RestApiTagArgs) ToRestApiTagOutputWithContext

func (i RestApiTagArgs) ToRestApiTagOutputWithContext(ctx context.Context) RestApiTagOutput

type RestApiTagArray

type RestApiTagArray []RestApiTagInput

func (RestApiTagArray) ElementType

func (RestApiTagArray) ElementType() reflect.Type

func (RestApiTagArray) ToOutput added in v0.76.0

func (RestApiTagArray) ToRestApiTagArrayOutput

func (i RestApiTagArray) ToRestApiTagArrayOutput() RestApiTagArrayOutput

func (RestApiTagArray) ToRestApiTagArrayOutputWithContext

func (i RestApiTagArray) ToRestApiTagArrayOutputWithContext(ctx context.Context) RestApiTagArrayOutput

type RestApiTagArrayInput

type RestApiTagArrayInput interface {
	pulumi.Input

	ToRestApiTagArrayOutput() RestApiTagArrayOutput
	ToRestApiTagArrayOutputWithContext(context.Context) RestApiTagArrayOutput
}

RestApiTagArrayInput is an input type that accepts RestApiTagArray and RestApiTagArrayOutput values. You can construct a concrete instance of `RestApiTagArrayInput` via:

RestApiTagArray{ RestApiTagArgs{...} }

type RestApiTagArrayOutput

type RestApiTagArrayOutput struct{ *pulumi.OutputState }

func (RestApiTagArrayOutput) ElementType

func (RestApiTagArrayOutput) ElementType() reflect.Type

func (RestApiTagArrayOutput) Index

func (RestApiTagArrayOutput) ToOutput added in v0.76.0

func (RestApiTagArrayOutput) ToRestApiTagArrayOutput

func (o RestApiTagArrayOutput) ToRestApiTagArrayOutput() RestApiTagArrayOutput

func (RestApiTagArrayOutput) ToRestApiTagArrayOutputWithContext

func (o RestApiTagArrayOutput) ToRestApiTagArrayOutputWithContext(ctx context.Context) RestApiTagArrayOutput

type RestApiTagInput

type RestApiTagInput interface {
	pulumi.Input

	ToRestApiTagOutput() RestApiTagOutput
	ToRestApiTagOutputWithContext(context.Context) RestApiTagOutput
}

RestApiTagInput is an input type that accepts RestApiTagArgs and RestApiTagOutput values. You can construct a concrete instance of `RestApiTagInput` via:

RestApiTagArgs{...}

type RestApiTagOutput

type RestApiTagOutput struct{ *pulumi.OutputState }

func (RestApiTagOutput) ElementType

func (RestApiTagOutput) ElementType() reflect.Type

func (RestApiTagOutput) Key

func (RestApiTagOutput) ToOutput added in v0.76.0

func (RestApiTagOutput) ToRestApiTagOutput

func (o RestApiTagOutput) ToRestApiTagOutput() RestApiTagOutput

func (RestApiTagOutput) ToRestApiTagOutputWithContext

func (o RestApiTagOutput) ToRestApiTagOutputWithContext(ctx context.Context) RestApiTagOutput

func (RestApiTagOutput) Value

type Stage

type Stage struct {
	pulumi.CustomResourceState

	// Specifies settings for logging access in this stage.
	AccessLogSetting StageAccessLogSettingPtrOutput `pulumi:"accessLogSetting"`
	// Indicates whether cache clustering is enabled for the stage.
	CacheClusterEnabled pulumi.BoolPtrOutput `pulumi:"cacheClusterEnabled"`
	// The stage's cache cluster size.
	CacheClusterSize pulumi.StringPtrOutput `pulumi:"cacheClusterSize"`
	// Specifies settings for the canary deployment in this stage.
	CanarySetting StageCanarySettingPtrOutput `pulumi:"canarySetting"`
	// The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
	ClientCertificateId pulumi.StringPtrOutput `pulumi:"clientCertificateId"`
	// The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
	DeploymentId pulumi.StringPtrOutput `pulumi:"deploymentId"`
	// A description of the stage.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The version ID of the API documentation snapshot.
	DocumentationVersion pulumi.StringPtrOutput `pulumi:"documentationVersion"`
	// Settings for all methods in the stage.
	MethodSettings StageMethodSettingArrayOutput `pulumi:"methodSettings"`
	// The ID of the RestApi resource that you're deploying with this stage.
	RestApiId pulumi.StringOutput `pulumi:"restApiId"`
	// The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
	StageName pulumi.StringPtrOutput `pulumi:"stageName"`
	// An array of arbitrary tags (key-value pairs) to associate with the stage.
	Tags StageTagArrayOutput `pulumi:"tags"`
	// Specifies whether active X-Ray tracing is enabled for this 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.
	Variables pulumi.AnyOutput `pulumi:"variables"`
}

Resource Type definition for AWS::ApiGateway::Stage

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) ToOutput added in v0.76.0

func (i *Stage) ToOutput(ctx context.Context) pulumix.Output[*Stage]

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"`
}

Specifies settings for logging access in this stage.

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"`
}

Specifies settings for logging access in this stage.

func (StageAccessLogSettingArgs) ElementType

func (StageAccessLogSettingArgs) ElementType() reflect.Type

func (StageAccessLogSettingArgs) ToOutput added in v0.76.0

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 }

Specifies settings for logging access in this stage.

func (StageAccessLogSettingOutput) DestinationArn

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) Format

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) ToOutput added in v0.76.0

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

type StageAccessLogSettingPtrOutput

type StageAccessLogSettingPtrOutput struct{ *pulumi.OutputState }

func (StageAccessLogSettingPtrOutput) DestinationArn

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 (StageAccessLogSettingPtrOutput) ElementType

func (StageAccessLogSettingPtrOutput) Format

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) ToOutput added in v0.76.0

func (StageAccessLogSettingPtrOutput) ToStageAccessLogSettingPtrOutput

func (o StageAccessLogSettingPtrOutput) ToStageAccessLogSettingPtrOutput() StageAccessLogSettingPtrOutput

func (StageAccessLogSettingPtrOutput) ToStageAccessLogSettingPtrOutputWithContext

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

type StageArgs

type StageArgs struct {
	// Specifies settings for logging access in this stage.
	AccessLogSetting StageAccessLogSettingPtrInput
	// Indicates whether cache clustering is enabled for the stage.
	CacheClusterEnabled pulumi.BoolPtrInput
	// The stage's cache cluster size.
	CacheClusterSize pulumi.StringPtrInput
	// Specifies settings for the canary deployment in this stage.
	CanarySetting StageCanarySettingPtrInput
	// The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
	ClientCertificateId pulumi.StringPtrInput
	// The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
	DeploymentId pulumi.StringPtrInput
	// A description of the stage.
	Description pulumi.StringPtrInput
	// The version ID of the API documentation snapshot.
	DocumentationVersion pulumi.StringPtrInput
	// Settings for all methods in the stage.
	MethodSettings StageMethodSettingArrayInput
	// The ID of the RestApi resource that you're deploying with this stage.
	RestApiId pulumi.StringInput
	// The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
	StageName pulumi.StringPtrInput
	// An array of arbitrary tags (key-value pairs) to associate with the stage.
	Tags StageTagArrayInput
	// Specifies whether active X-Ray tracing is enabled for this 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.
	Variables pulumi.Input
}

The set of arguments for constructing a Stage resource.

func (StageArgs) ElementType

func (StageArgs) ElementType() reflect.Type

type StageCanarySetting

type StageCanarySetting struct {
	// The identifier of the deployment that the stage points to.
	DeploymentId *string `pulumi:"deploymentId"`
	// The percentage (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 interface{} `pulumi:"stageVariableOverrides"`
	// Whether the canary deployment uses the stage cache or not.
	UseStageCache *bool `pulumi:"useStageCache"`
}

Specifies settings for the canary deployment in this stage.

type StageCanarySettingArgs

type StageCanarySettingArgs struct {
	// The identifier of the deployment that the stage points to.
	DeploymentId pulumi.StringPtrInput `pulumi:"deploymentId"`
	// The percentage (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.Input `pulumi:"stageVariableOverrides"`
	// Whether the canary deployment uses the stage cache or not.
	UseStageCache pulumi.BoolPtrInput `pulumi:"useStageCache"`
}

Specifies settings for the canary deployment in this stage.

func (StageCanarySettingArgs) ElementType

func (StageCanarySettingArgs) ElementType() reflect.Type

func (StageCanarySettingArgs) ToOutput added in v0.76.0

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 }

Specifies settings for the canary deployment in this stage.

func (StageCanarySettingOutput) DeploymentId

The identifier of the deployment that the stage points to.

func (StageCanarySettingOutput) ElementType

func (StageCanarySettingOutput) ElementType() reflect.Type

func (StageCanarySettingOutput) PercentTraffic

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

func (StageCanarySettingOutput) StageVariableOverrides

func (o StageCanarySettingOutput) StageVariableOverrides() pulumi.AnyOutput

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) ToOutput added in v0.76.0

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

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

type StageCanarySettingPtrOutput

type StageCanarySettingPtrOutput struct{ *pulumi.OutputState }

func (StageCanarySettingPtrOutput) DeploymentId

The identifier of the deployment that the stage points to.

func (StageCanarySettingPtrOutput) Elem

func (StageCanarySettingPtrOutput) ElementType

func (StageCanarySettingPtrOutput) PercentTraffic

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

func (StageCanarySettingPtrOutput) StageVariableOverrides

func (o StageCanarySettingPtrOutput) StageVariableOverrides() pulumi.AnyOutput

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) ToOutput added in v0.76.0

func (StageCanarySettingPtrOutput) ToStageCanarySettingPtrOutput

func (o StageCanarySettingPtrOutput) ToStageCanarySettingPtrOutput() StageCanarySettingPtrOutput

func (StageCanarySettingPtrOutput) ToStageCanarySettingPtrOutputWithContext

func (o StageCanarySettingPtrOutput) ToStageCanarySettingPtrOutputWithContext(ctx context.Context) StageCanarySettingPtrOutput

func (StageCanarySettingPtrOutput) UseStageCache

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 {
	// 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.
	CachingEnabled *bool `pulumi:"cachingEnabled"`
	// 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"`
	// The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
	HttpMethod *string `pulumi:"httpMethod"`
	// The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.
	LoggingLevel *string `pulumi:"loggingLevel"`
	// Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
	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 (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
	ResourcePath *string `pulumi:"resourcePath"`
	// The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingBurstLimit *int `pulumi:"throttlingBurstLimit"`
	// The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingRateLimit *float64 `pulumi:"throttlingRateLimit"`
}

Configures settings for all methods in a stage.

type StageMethodSettingArgs

type StageMethodSettingArgs struct {
	// 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.
	CachingEnabled pulumi.BoolPtrInput `pulumi:"cachingEnabled"`
	// 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"`
	// The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
	HttpMethod pulumi.StringPtrInput `pulumi:"httpMethod"`
	// The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.
	LoggingLevel pulumi.StringPtrInput `pulumi:"loggingLevel"`
	// Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
	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 (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
	ResourcePath pulumi.StringPtrInput `pulumi:"resourcePath"`
	// The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingBurstLimit pulumi.IntPtrInput `pulumi:"throttlingBurstLimit"`
	// The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
	ThrottlingRateLimit pulumi.Float64PtrInput `pulumi:"throttlingRateLimit"`
}

Configures settings for all methods in a stage.

func (StageMethodSettingArgs) ElementType

func (StageMethodSettingArgs) ElementType() reflect.Type

func (StageMethodSettingArgs) ToOutput added in v0.76.0

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) ToOutput added in v0.76.0

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) Index

func (StageMethodSettingArrayOutput) ToOutput added in v0.76.0

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 }

Configures settings for all methods in a stage.

func (StageMethodSettingOutput) CacheDataEncrypted

func (o StageMethodSettingOutput) CacheDataEncrypted() pulumi.BoolPtrOutput

Indicates whether the cached responses are encrypted.

func (StageMethodSettingOutput) CacheTtlInSeconds

func (o StageMethodSettingOutput) CacheTtlInSeconds() pulumi.IntPtrOutput

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

func (StageMethodSettingOutput) CachingEnabled

func (o StageMethodSettingOutput) CachingEnabled() pulumi.BoolPtrOutput

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

func (StageMethodSettingOutput) DataTraceEnabled

func (o StageMethodSettingOutput) 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 (StageMethodSettingOutput) ElementType

func (StageMethodSettingOutput) ElementType() reflect.Type

func (StageMethodSettingOutput) HttpMethod

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

func (StageMethodSettingOutput) LoggingLevel

The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.

func (StageMethodSettingOutput) MetricsEnabled

func (o StageMethodSettingOutput) MetricsEnabled() pulumi.BoolPtrOutput

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

func (StageMethodSettingOutput) ResourcePath

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 (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

func (StageMethodSettingOutput) ThrottlingBurstLimit

func (o StageMethodSettingOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

func (StageMethodSettingOutput) ThrottlingRateLimit

func (o StageMethodSettingOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

func (StageMethodSettingOutput) ToOutput added in v0.76.0

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

Specifies settings for logging access in this stage.

func (StageOutput) CacheClusterEnabled added in v0.17.0

func (o StageOutput) CacheClusterEnabled() pulumi.BoolPtrOutput

Indicates whether cache clustering is enabled for the stage.

func (StageOutput) CacheClusterSize added in v0.17.0

func (o StageOutput) CacheClusterSize() pulumi.StringPtrOutput

The stage's cache cluster size.

func (StageOutput) CanarySetting added in v0.17.0

func (o StageOutput) CanarySetting() StageCanarySettingPtrOutput

Specifies settings for the canary deployment in this stage.

func (StageOutput) ClientCertificateId added in v0.17.0

func (o StageOutput) ClientCertificateId() pulumi.StringPtrOutput

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

func (StageOutput) DeploymentId added in v0.17.0

func (o StageOutput) DeploymentId() pulumi.StringPtrOutput

The ID of the deployment that the stage is associated with. This parameter is required to create a stage.

func (StageOutput) Description added in v0.17.0

func (o StageOutput) Description() pulumi.StringPtrOutput

A description of the stage.

func (StageOutput) DocumentationVersion added in v0.17.0

func (o StageOutput) DocumentationVersion() pulumi.StringPtrOutput

The version ID of the API documentation snapshot.

func (StageOutput) ElementType

func (StageOutput) ElementType() reflect.Type

func (StageOutput) MethodSettings added in v0.17.0

func (o StageOutput) MethodSettings() StageMethodSettingArrayOutput

Settings for all methods in the stage.

func (StageOutput) RestApiId added in v0.17.0

func (o StageOutput) RestApiId() pulumi.StringOutput

The ID of the RestApi resource that you're deploying with this stage.

func (StageOutput) StageName added in v0.17.0

func (o StageOutput) StageName() pulumi.StringPtrOutput

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

func (StageOutput) Tags added in v0.17.0

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

func (StageOutput) ToOutput added in v0.76.0

func (o StageOutput) ToOutput(ctx context.Context) pulumix.Output[*Stage]

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 X-Ray tracing is enabled for this stage.

func (StageOutput) Variables added in v0.17.0

func (o StageOutput) Variables() pulumi.AnyOutput

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.

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"`
}

Identify and categorize resources.

type StageTagArgs

type StageTagArgs 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 pulumi.StringInput `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 pulumi.StringInput `pulumi:"value"`
}

Identify and categorize resources.

func (StageTagArgs) ElementType

func (StageTagArgs) ElementType() reflect.Type

func (StageTagArgs) ToOutput added in v0.76.0

func (StageTagArgs) ToStageTagOutput

func (i StageTagArgs) ToStageTagOutput() StageTagOutput

func (StageTagArgs) ToStageTagOutputWithContext

func (i StageTagArgs) ToStageTagOutputWithContext(ctx context.Context) StageTagOutput

type StageTagArray

type StageTagArray []StageTagInput

func (StageTagArray) ElementType

func (StageTagArray) ElementType() reflect.Type

func (StageTagArray) ToOutput added in v0.76.0

func (i StageTagArray) ToOutput(ctx context.Context) pulumix.Output[[]StageTag]

func (StageTagArray) ToStageTagArrayOutput

func (i StageTagArray) ToStageTagArrayOutput() StageTagArrayOutput

func (StageTagArray) ToStageTagArrayOutputWithContext

func (i StageTagArray) ToStageTagArrayOutputWithContext(ctx context.Context) StageTagArrayOutput

type StageTagArrayInput

type StageTagArrayInput interface {
	pulumi.Input

	ToStageTagArrayOutput() StageTagArrayOutput
	ToStageTagArrayOutputWithContext(context.Context) StageTagArrayOutput
}

StageTagArrayInput is an input type that accepts StageTagArray and StageTagArrayOutput values. You can construct a concrete instance of `StageTagArrayInput` via:

StageTagArray{ StageTagArgs{...} }

type StageTagArrayOutput

type StageTagArrayOutput struct{ *pulumi.OutputState }

func (StageTagArrayOutput) ElementType

func (StageTagArrayOutput) ElementType() reflect.Type

func (StageTagArrayOutput) Index

func (StageTagArrayOutput) ToOutput added in v0.76.0

func (StageTagArrayOutput) ToStageTagArrayOutput

func (o StageTagArrayOutput) ToStageTagArrayOutput() StageTagArrayOutput

func (StageTagArrayOutput) ToStageTagArrayOutputWithContext

func (o StageTagArrayOutput) ToStageTagArrayOutputWithContext(ctx context.Context) StageTagArrayOutput

type StageTagInput

type StageTagInput interface {
	pulumi.Input

	ToStageTagOutput() StageTagOutput
	ToStageTagOutputWithContext(context.Context) StageTagOutput
}

StageTagInput is an input type that accepts StageTagArgs and StageTagOutput values. You can construct a concrete instance of `StageTagInput` via:

StageTagArgs{...}

type StageTagOutput

type StageTagOutput struct{ *pulumi.OutputState }

Identify and categorize resources.

func (StageTagOutput) ElementType

func (StageTagOutput) ElementType() reflect.Type

func (StageTagOutput) Key

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

func (StageTagOutput) ToOutput added in v0.76.0

func (StageTagOutput) ToStageTagOutput

func (o StageTagOutput) ToStageTagOutput() StageTagOutput

func (StageTagOutput) ToStageTagOutputWithContext

func (o StageTagOutput) ToStageTagOutputWithContext(ctx context.Context) StageTagOutput

func (StageTagOutput) Value

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

type UsagePlan

type UsagePlan struct {
	pulumi.CustomResourceState

	// The API stages to associate with this usage plan.
	ApiStages UsagePlanApiStageArrayOutput `pulumi:"apiStages"`
	// A description of the usage plan.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Configures the number of requests that users can make within a given interval.
	Quota UsagePlanQuotaSettingsPtrOutput `pulumi:"quota"`
	// An array of arbitrary tags (key-value pairs) to associate with the usage plan.
	Tags UsagePlanTagArrayOutput `pulumi:"tags"`
	// Configures the overall request rate (average requests per second) and burst capacity.
	Throttle UsagePlanThrottleSettingsPtrOutput `pulumi:"throttle"`
	// A name for the usage plan.
	UsagePlanName pulumi.StringPtrOutput `pulumi:"usagePlanName"`
}

Resource Type definition for AWS::ApiGateway::UsagePlan

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) ToOutput added in v0.76.0

func (i *UsagePlan) ToOutput(ctx context.Context) pulumix.Output[*UsagePlan]

func (*UsagePlan) ToUsagePlanOutput

func (i *UsagePlan) ToUsagePlanOutput() UsagePlanOutput

func (*UsagePlan) ToUsagePlanOutputWithContext

func (i *UsagePlan) ToUsagePlanOutputWithContext(ctx context.Context) UsagePlanOutput

type UsagePlanApiStage

type UsagePlanApiStage struct {
	// The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
	ApiId *string `pulumi:"apiId"`
	// The name of the stage to associate with the usage plan.
	Stage *string `pulumi:"stage"`
	// Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed.
	Throttle interface{} `pulumi:"throttle"`
}

type UsagePlanApiStageArgs

type UsagePlanApiStageArgs struct {
	// The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
	ApiId pulumi.StringPtrInput `pulumi:"apiId"`
	// The name of the stage to associate with the usage plan.
	Stage pulumi.StringPtrInput `pulumi:"stage"`
	// Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed.
	Throttle pulumi.Input `pulumi:"throttle"`
}

func (UsagePlanApiStageArgs) ElementType

func (UsagePlanApiStageArgs) ElementType() reflect.Type

func (UsagePlanApiStageArgs) ToOutput added in v0.76.0

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) ToOutput added in v0.76.0

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) Index

func (UsagePlanApiStageArrayOutput) ToOutput added in v0.76.0

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 }

func (UsagePlanApiStageOutput) ApiId

The ID of an API that is in the specified Stage property that you want to associate with the usage plan.

func (UsagePlanApiStageOutput) ElementType

func (UsagePlanApiStageOutput) ElementType() reflect.Type

func (UsagePlanApiStageOutput) Stage

The name of the stage to associate with the usage plan.

func (UsagePlanApiStageOutput) Throttle

Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed.

func (UsagePlanApiStageOutput) ToOutput added in v0.76.0

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 API stages to associate with this usage plan.
	ApiStages UsagePlanApiStageArrayInput
	// A description of the usage plan.
	Description pulumi.StringPtrInput
	// Configures the number of requests that users can make within a given interval.
	Quota UsagePlanQuotaSettingsPtrInput
	// An array of arbitrary tags (key-value pairs) to associate with the usage plan.
	Tags UsagePlanTagArrayInput
	// Configures the overall request rate (average requests per second) and burst capacity.
	Throttle UsagePlanThrottleSettingsPtrInput
	// A name for the 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

	// The ID of the usage plan key.
	KeyId pulumi.StringOutput `pulumi:"keyId"`
	// The type of usage plan key. Currently, the only valid key type is API_KEY.
	KeyType UsagePlanKeyKeyTypeOutput `pulumi:"keyType"`
	// The ID of the usage plan.
	UsagePlanId pulumi.StringOutput `pulumi:"usagePlanId"`
}

Resource Type definition for AWS::ApiGateway::UsagePlanKey

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) ToOutput added in v0.76.0

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 usage plan key.
	KeyId pulumi.StringInput
	// The type of usage plan key. Currently, the only valid key type is API_KEY.
	KeyType UsagePlanKeyKeyTypeInput
	// The ID of the usage plan.
	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 usage plan key. Currently, the only valid key type is API_KEY.

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 UsagePlanKeyKeyTypeArgs and UsagePlanKeyKeyTypeOutput values. You can construct a concrete instance of `UsagePlanKeyKeyTypeInput` via:

UsagePlanKeyKeyTypeArgs{...}

type UsagePlanKeyKeyTypeOutput

type UsagePlanKeyKeyTypeOutput struct{ *pulumi.OutputState }

func (UsagePlanKeyKeyTypeOutput) ElementType

func (UsagePlanKeyKeyTypeOutput) ElementType() reflect.Type

func (UsagePlanKeyKeyTypeOutput) ToOutput added in v0.76.0

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 (UsagePlanKeyKeyTypePtrOutput) ElementType

func (UsagePlanKeyKeyTypePtrOutput) ToOutput added in v0.76.0

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) ElementType

func (UsagePlanKeyOutput) ElementType() reflect.Type

func (UsagePlanKeyOutput) KeyId added in v0.17.0

The ID of the usage plan key.

func (UsagePlanKeyOutput) KeyType added in v0.17.0

The type of usage plan key. Currently, the only valid key type is API_KEY.

func (UsagePlanKeyOutput) ToOutput added in v0.76.0

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 usage plan.

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

The API stages to associate with this usage plan.

func (UsagePlanOutput) Description added in v0.17.0

func (o UsagePlanOutput) Description() pulumi.StringPtrOutput

A description of the usage plan.

func (UsagePlanOutput) ElementType

func (UsagePlanOutput) ElementType() reflect.Type

func (UsagePlanOutput) Quota added in v0.17.0

Configures the number of requests that users can make within a given interval.

func (UsagePlanOutput) Tags added in v0.17.0

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

func (UsagePlanOutput) Throttle added in v0.17.0

Configures the overall request rate (average requests per second) and burst capacity.

func (UsagePlanOutput) ToOutput added in v0.76.0

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

A name for the usage plan.

type UsagePlanQuotaSettings

type UsagePlanQuotaSettings struct {
	// The maximum number of requests that users can make within the specified time period.
	Limit *int `pulumi:"limit"`
	// For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period.
	Offset *int `pulumi:"offset"`
	// The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference.
	Period *string `pulumi:"period"`
}

type UsagePlanQuotaSettingsArgs

type UsagePlanQuotaSettingsArgs struct {
	// The maximum number of requests that users can make within the specified time period.
	Limit pulumi.IntPtrInput `pulumi:"limit"`
	// For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period.
	Offset pulumi.IntPtrInput `pulumi:"offset"`
	// The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference.
	Period pulumi.StringPtrInput `pulumi:"period"`
}

func (UsagePlanQuotaSettingsArgs) ElementType

func (UsagePlanQuotaSettingsArgs) ElementType() reflect.Type

func (UsagePlanQuotaSettingsArgs) ToOutput added in v0.76.0

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 }

func (UsagePlanQuotaSettingsOutput) ElementType

func (UsagePlanQuotaSettingsOutput) Limit

The maximum number of requests that users can make within the specified time period.

func (UsagePlanQuotaSettingsOutput) Offset

For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period.

func (UsagePlanQuotaSettingsOutput) Period

The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference.

func (UsagePlanQuotaSettingsOutput) ToOutput added in v0.76.0

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

type UsagePlanQuotaSettingsPtrOutput

type UsagePlanQuotaSettingsPtrOutput struct{ *pulumi.OutputState }

func (UsagePlanQuotaSettingsPtrOutput) Elem

func (UsagePlanQuotaSettingsPtrOutput) ElementType

func (UsagePlanQuotaSettingsPtrOutput) Limit

The maximum number of requests that users can make within the specified time period.

func (UsagePlanQuotaSettingsPtrOutput) Offset

For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period.

func (UsagePlanQuotaSettingsPtrOutput) Period

The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference.

func (UsagePlanQuotaSettingsPtrOutput) ToOutput added in v0.76.0

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 UsagePlanTagArgs

type UsagePlanTagArgs 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 pulumi.StringInput `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 pulumi.StringInput `pulumi:"value"`
}

func (UsagePlanTagArgs) ElementType

func (UsagePlanTagArgs) ElementType() reflect.Type

func (UsagePlanTagArgs) ToOutput added in v0.76.0

func (UsagePlanTagArgs) ToUsagePlanTagOutput

func (i UsagePlanTagArgs) ToUsagePlanTagOutput() UsagePlanTagOutput

func (UsagePlanTagArgs) ToUsagePlanTagOutputWithContext

func (i UsagePlanTagArgs) ToUsagePlanTagOutputWithContext(ctx context.Context) UsagePlanTagOutput

type UsagePlanTagArray

type UsagePlanTagArray []UsagePlanTagInput

func (UsagePlanTagArray) ElementType

func (UsagePlanTagArray) ElementType() reflect.Type

func (UsagePlanTagArray) ToOutput added in v0.76.0

func (UsagePlanTagArray) ToUsagePlanTagArrayOutput

func (i UsagePlanTagArray) ToUsagePlanTagArrayOutput() UsagePlanTagArrayOutput

func (UsagePlanTagArray) ToUsagePlanTagArrayOutputWithContext

func (i UsagePlanTagArray) ToUsagePlanTagArrayOutputWithContext(ctx context.Context) UsagePlanTagArrayOutput

type UsagePlanTagArrayInput

type UsagePlanTagArrayInput interface {
	pulumi.Input

	ToUsagePlanTagArrayOutput() UsagePlanTagArrayOutput
	ToUsagePlanTagArrayOutputWithContext(context.Context) UsagePlanTagArrayOutput
}

UsagePlanTagArrayInput is an input type that accepts UsagePlanTagArray and UsagePlanTagArrayOutput values. You can construct a concrete instance of `UsagePlanTagArrayInput` via:

UsagePlanTagArray{ UsagePlanTagArgs{...} }

type UsagePlanTagArrayOutput

type UsagePlanTagArrayOutput struct{ *pulumi.OutputState }

func (UsagePlanTagArrayOutput) ElementType

func (UsagePlanTagArrayOutput) ElementType() reflect.Type

func (UsagePlanTagArrayOutput) Index

func (UsagePlanTagArrayOutput) ToOutput added in v0.76.0

func (UsagePlanTagArrayOutput) ToUsagePlanTagArrayOutput

func (o UsagePlanTagArrayOutput) ToUsagePlanTagArrayOutput() UsagePlanTagArrayOutput

func (UsagePlanTagArrayOutput) ToUsagePlanTagArrayOutputWithContext

func (o UsagePlanTagArrayOutput) ToUsagePlanTagArrayOutputWithContext(ctx context.Context) UsagePlanTagArrayOutput

type UsagePlanTagInput

type UsagePlanTagInput interface {
	pulumi.Input

	ToUsagePlanTagOutput() UsagePlanTagOutput
	ToUsagePlanTagOutputWithContext(context.Context) UsagePlanTagOutput
}

UsagePlanTagInput is an input type that accepts UsagePlanTagArgs and UsagePlanTagOutput values. You can construct a concrete instance of `UsagePlanTagInput` via:

UsagePlanTagArgs{...}

type UsagePlanTagOutput

type UsagePlanTagOutput struct{ *pulumi.OutputState }

func (UsagePlanTagOutput) ElementType

func (UsagePlanTagOutput) ElementType() reflect.Type

func (UsagePlanTagOutput) Key

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

func (UsagePlanTagOutput) ToOutput added in v0.76.0

func (UsagePlanTagOutput) ToUsagePlanTagOutput

func (o UsagePlanTagOutput) ToUsagePlanTagOutput() UsagePlanTagOutput

func (UsagePlanTagOutput) ToUsagePlanTagOutputWithContext

func (o UsagePlanTagOutput) ToUsagePlanTagOutputWithContext(ctx context.Context) UsagePlanTagOutput

func (UsagePlanTagOutput) Value

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

type UsagePlanThrottleSettings

type UsagePlanThrottleSettings struct {
	// The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
	BurstLimit *int `pulumi:"burstLimit"`
	// The API request steady-state rate limit (average requests per second over an extended period of time).
	RateLimit *float64 `pulumi:"rateLimit"`
}

type UsagePlanThrottleSettingsArgs

type UsagePlanThrottleSettingsArgs struct {
	// The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
	BurstLimit pulumi.IntPtrInput `pulumi:"burstLimit"`
	// The API request steady-state rate limit (average requests per second over an extended period of time).
	RateLimit pulumi.Float64PtrInput `pulumi:"rateLimit"`
}

func (UsagePlanThrottleSettingsArgs) ElementType

func (UsagePlanThrottleSettingsArgs) ToOutput added in v0.76.0

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 UsagePlanThrottleSettingsOutput

type UsagePlanThrottleSettingsOutput struct{ *pulumi.OutputState }

func (UsagePlanThrottleSettingsOutput) BurstLimit

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

func (UsagePlanThrottleSettingsOutput) ElementType

func (UsagePlanThrottleSettingsOutput) RateLimit

The API request steady-state rate limit (average requests per second over an extended period of time).

func (UsagePlanThrottleSettingsOutput) ToOutput added in v0.76.0

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

type UsagePlanThrottleSettingsPtrOutput

type UsagePlanThrottleSettingsPtrOutput struct{ *pulumi.OutputState }

func (UsagePlanThrottleSettingsPtrOutput) BurstLimit

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

func (UsagePlanThrottleSettingsPtrOutput) Elem

func (UsagePlanThrottleSettingsPtrOutput) ElementType

func (UsagePlanThrottleSettingsPtrOutput) RateLimit

The API request steady-state rate limit (average requests per second over an extended period of time).

func (UsagePlanThrottleSettingsPtrOutput) ToOutput added in v0.76.0

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 VpcLinkTagArrayOutput `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) ToOutput added in v0.76.0

func (i *VpcLink) ToOutput(ctx context.Context) pulumix.Output[*VpcLink]

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 VpcLinkTagArrayInput
	// 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

A name for the VPC link.

func (VpcLinkOutput) Tags added in v0.17.0

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) ToOutput added in v0.76.0

func (o VpcLinkOutput) ToOutput(ctx context.Context) pulumix.Output[*VpcLink]

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"`
}

type VpcLinkTagArgs added in v0.3.0

type VpcLinkTagArgs struct {
	Key   pulumi.StringInput `pulumi:"key"`
	Value pulumi.StringInput `pulumi:"value"`
}

func (VpcLinkTagArgs) ElementType added in v0.3.0

func (VpcLinkTagArgs) ElementType() reflect.Type

func (VpcLinkTagArgs) ToOutput added in v0.76.0

func (VpcLinkTagArgs) ToVpcLinkTagOutput added in v0.3.0

func (i VpcLinkTagArgs) ToVpcLinkTagOutput() VpcLinkTagOutput

func (VpcLinkTagArgs) ToVpcLinkTagOutputWithContext added in v0.3.0

func (i VpcLinkTagArgs) ToVpcLinkTagOutputWithContext(ctx context.Context) VpcLinkTagOutput

type VpcLinkTagArray added in v0.3.0

type VpcLinkTagArray []VpcLinkTagInput

func (VpcLinkTagArray) ElementType added in v0.3.0

func (VpcLinkTagArray) ElementType() reflect.Type

func (VpcLinkTagArray) ToOutput added in v0.76.0

func (VpcLinkTagArray) ToVpcLinkTagArrayOutput added in v0.3.0

func (i VpcLinkTagArray) ToVpcLinkTagArrayOutput() VpcLinkTagArrayOutput

func (VpcLinkTagArray) ToVpcLinkTagArrayOutputWithContext added in v0.3.0

func (i VpcLinkTagArray) ToVpcLinkTagArrayOutputWithContext(ctx context.Context) VpcLinkTagArrayOutput

type VpcLinkTagArrayInput added in v0.3.0

type VpcLinkTagArrayInput interface {
	pulumi.Input

	ToVpcLinkTagArrayOutput() VpcLinkTagArrayOutput
	ToVpcLinkTagArrayOutputWithContext(context.Context) VpcLinkTagArrayOutput
}

VpcLinkTagArrayInput is an input type that accepts VpcLinkTagArray and VpcLinkTagArrayOutput values. You can construct a concrete instance of `VpcLinkTagArrayInput` via:

VpcLinkTagArray{ VpcLinkTagArgs{...} }

type VpcLinkTagArrayOutput added in v0.3.0

type VpcLinkTagArrayOutput struct{ *pulumi.OutputState }

func (VpcLinkTagArrayOutput) ElementType added in v0.3.0

func (VpcLinkTagArrayOutput) ElementType() reflect.Type

func (VpcLinkTagArrayOutput) Index added in v0.3.0

func (VpcLinkTagArrayOutput) ToOutput added in v0.76.0

func (VpcLinkTagArrayOutput) ToVpcLinkTagArrayOutput added in v0.3.0

func (o VpcLinkTagArrayOutput) ToVpcLinkTagArrayOutput() VpcLinkTagArrayOutput

func (VpcLinkTagArrayOutput) ToVpcLinkTagArrayOutputWithContext added in v0.3.0

func (o VpcLinkTagArrayOutput) ToVpcLinkTagArrayOutputWithContext(ctx context.Context) VpcLinkTagArrayOutput

type VpcLinkTagInput added in v0.3.0

type VpcLinkTagInput interface {
	pulumi.Input

	ToVpcLinkTagOutput() VpcLinkTagOutput
	ToVpcLinkTagOutputWithContext(context.Context) VpcLinkTagOutput
}

VpcLinkTagInput is an input type that accepts VpcLinkTagArgs and VpcLinkTagOutput values. You can construct a concrete instance of `VpcLinkTagInput` via:

VpcLinkTagArgs{...}

type VpcLinkTagOutput added in v0.3.0

type VpcLinkTagOutput struct{ *pulumi.OutputState }

func (VpcLinkTagOutput) ElementType added in v0.3.0

func (VpcLinkTagOutput) ElementType() reflect.Type

func (VpcLinkTagOutput) Key added in v0.3.0

func (VpcLinkTagOutput) ToOutput added in v0.76.0

func (VpcLinkTagOutput) ToVpcLinkTagOutput added in v0.3.0

func (o VpcLinkTagOutput) ToVpcLinkTagOutput() VpcLinkTagOutput

func (VpcLinkTagOutput) ToVpcLinkTagOutputWithContext added in v0.3.0

func (o VpcLinkTagOutput) ToVpcLinkTagOutputWithContext(ctx context.Context) VpcLinkTagOutput

func (VpcLinkTagOutput) Value added in v0.3.0

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL