Documentation ¶
Index ¶
- type Api
- type ApiArgs
- type ApiState
- type Authorizer
- type AuthorizerArgs
- type AuthorizerJwtConfiguration
- type AuthorizerJwtConfigurationArgs
- func (AuthorizerJwtConfigurationArgs) ElementType() reflect.Type
- func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutput() AuthorizerJwtConfigurationOutput
- func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationOutput
- func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput
- func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationPtrOutput
- type AuthorizerJwtConfigurationInput
- type AuthorizerJwtConfigurationOutput
- func (o AuthorizerJwtConfigurationOutput) Audiences() pulumi.StringArrayOutput
- func (AuthorizerJwtConfigurationOutput) ElementType() reflect.Type
- func (o AuthorizerJwtConfigurationOutput) Issuer() pulumi.StringPtrOutput
- func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutput() AuthorizerJwtConfigurationOutput
- func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationOutput
- func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput
- func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationPtrOutput
- type AuthorizerJwtConfigurationPtrInput
- type AuthorizerJwtConfigurationPtrOutput
- func (o AuthorizerJwtConfigurationPtrOutput) Audiences() pulumi.StringArrayOutput
- func (o AuthorizerJwtConfigurationPtrOutput) Elem() AuthorizerJwtConfigurationOutput
- func (AuthorizerJwtConfigurationPtrOutput) ElementType() reflect.Type
- func (o AuthorizerJwtConfigurationPtrOutput) Issuer() pulumi.StringPtrOutput
- func (o AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput
- func (o AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationPtrOutput
- type AuthorizerState
- type Deployment
- type DeploymentArgs
- type DeploymentState
- type DomainName
- type DomainNameArgs
- type DomainNameDomainNameConfiguration
- type DomainNameDomainNameConfigurationArgs
- func (DomainNameDomainNameConfigurationArgs) ElementType() reflect.Type
- func (i DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationOutput() DomainNameDomainNameConfigurationOutput
- func (i DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationOutput
- func (i DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationPtrOutput() DomainNameDomainNameConfigurationPtrOutput
- func (i DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationPtrOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationPtrOutput
- type DomainNameDomainNameConfigurationInput
- type DomainNameDomainNameConfigurationOutput
- func (o DomainNameDomainNameConfigurationOutput) CertificateArn() pulumi.StringOutput
- func (DomainNameDomainNameConfigurationOutput) ElementType() reflect.Type
- func (o DomainNameDomainNameConfigurationOutput) EndpointType() pulumi.StringOutput
- func (o DomainNameDomainNameConfigurationOutput) HostedZoneId() pulumi.StringPtrOutput
- func (o DomainNameDomainNameConfigurationOutput) SecurityPolicy() pulumi.StringOutput
- func (o DomainNameDomainNameConfigurationOutput) TargetDomainName() pulumi.StringPtrOutput
- func (o DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationOutput() DomainNameDomainNameConfigurationOutput
- func (o DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationOutput
- func (o DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationPtrOutput() DomainNameDomainNameConfigurationPtrOutput
- func (o DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationPtrOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationPtrOutput
- type DomainNameDomainNameConfigurationPtrInput
- type DomainNameDomainNameConfigurationPtrOutput
- func (o DomainNameDomainNameConfigurationPtrOutput) CertificateArn() pulumi.StringPtrOutput
- func (o DomainNameDomainNameConfigurationPtrOutput) Elem() DomainNameDomainNameConfigurationOutput
- func (DomainNameDomainNameConfigurationPtrOutput) ElementType() reflect.Type
- func (o DomainNameDomainNameConfigurationPtrOutput) EndpointType() pulumi.StringPtrOutput
- func (o DomainNameDomainNameConfigurationPtrOutput) HostedZoneId() pulumi.StringPtrOutput
- func (o DomainNameDomainNameConfigurationPtrOutput) SecurityPolicy() pulumi.StringPtrOutput
- func (o DomainNameDomainNameConfigurationPtrOutput) TargetDomainName() pulumi.StringPtrOutput
- func (o DomainNameDomainNameConfigurationPtrOutput) ToDomainNameDomainNameConfigurationPtrOutput() DomainNameDomainNameConfigurationPtrOutput
- func (o DomainNameDomainNameConfigurationPtrOutput) ToDomainNameDomainNameConfigurationPtrOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationPtrOutput
- type DomainNameState
- type Integration
- type IntegrationArgs
- type IntegrationResponse
- type IntegrationResponseArgs
- type IntegrationResponseState
- type IntegrationState
- type Model
- type ModelArgs
- type ModelState
- type Route
- type RouteArgs
- type RouteResponse
- type RouteResponseArgs
- type RouteResponseState
- type RouteState
- type Stage
- type StageAccessLogSettings
- type StageAccessLogSettingsArgs
- func (StageAccessLogSettingsArgs) ElementType() reflect.Type
- func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutput() StageAccessLogSettingsOutput
- func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutputWithContext(ctx context.Context) StageAccessLogSettingsOutput
- func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput
- func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutputWithContext(ctx context.Context) StageAccessLogSettingsPtrOutput
- type StageAccessLogSettingsInput
- type StageAccessLogSettingsOutput
- func (o StageAccessLogSettingsOutput) DestinationArn() pulumi.StringOutput
- func (StageAccessLogSettingsOutput) ElementType() reflect.Type
- func (o StageAccessLogSettingsOutput) Format() pulumi.StringOutput
- func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutput() StageAccessLogSettingsOutput
- func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutputWithContext(ctx context.Context) StageAccessLogSettingsOutput
- func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput
- func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutputWithContext(ctx context.Context) StageAccessLogSettingsPtrOutput
- type StageAccessLogSettingsPtrInput
- type StageAccessLogSettingsPtrOutput
- func (o StageAccessLogSettingsPtrOutput) DestinationArn() pulumi.StringPtrOutput
- func (o StageAccessLogSettingsPtrOutput) Elem() StageAccessLogSettingsOutput
- func (StageAccessLogSettingsPtrOutput) ElementType() reflect.Type
- func (o StageAccessLogSettingsPtrOutput) Format() pulumi.StringPtrOutput
- func (o StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput
- func (o StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutputWithContext(ctx context.Context) StageAccessLogSettingsPtrOutput
- type StageArgs
- type StageDefaultRouteSettings
- type StageDefaultRouteSettingsArgs
- func (StageDefaultRouteSettingsArgs) ElementType() reflect.Type
- func (i StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsOutput() StageDefaultRouteSettingsOutput
- func (i StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsOutputWithContext(ctx context.Context) StageDefaultRouteSettingsOutput
- func (i StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsPtrOutput() StageDefaultRouteSettingsPtrOutput
- func (i StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsPtrOutputWithContext(ctx context.Context) StageDefaultRouteSettingsPtrOutput
- type StageDefaultRouteSettingsInput
- type StageDefaultRouteSettingsOutput
- func (o StageDefaultRouteSettingsOutput) DataTraceEnabled() pulumi.BoolPtrOutput
- func (o StageDefaultRouteSettingsOutput) DetailedMetricsEnabled() pulumi.BoolPtrOutput
- func (StageDefaultRouteSettingsOutput) ElementType() reflect.Type
- func (o StageDefaultRouteSettingsOutput) LoggingLevel() pulumi.StringPtrOutput
- func (o StageDefaultRouteSettingsOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput
- func (o StageDefaultRouteSettingsOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput
- func (o StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsOutput() StageDefaultRouteSettingsOutput
- func (o StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsOutputWithContext(ctx context.Context) StageDefaultRouteSettingsOutput
- func (o StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsPtrOutput() StageDefaultRouteSettingsPtrOutput
- func (o StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsPtrOutputWithContext(ctx context.Context) StageDefaultRouteSettingsPtrOutput
- type StageDefaultRouteSettingsPtrInput
- type StageDefaultRouteSettingsPtrOutput
- func (o StageDefaultRouteSettingsPtrOutput) DataTraceEnabled() pulumi.BoolPtrOutput
- func (o StageDefaultRouteSettingsPtrOutput) DetailedMetricsEnabled() pulumi.BoolPtrOutput
- func (o StageDefaultRouteSettingsPtrOutput) Elem() StageDefaultRouteSettingsOutput
- func (StageDefaultRouteSettingsPtrOutput) ElementType() reflect.Type
- func (o StageDefaultRouteSettingsPtrOutput) LoggingLevel() pulumi.StringPtrOutput
- func (o StageDefaultRouteSettingsPtrOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput
- func (o StageDefaultRouteSettingsPtrOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput
- func (o StageDefaultRouteSettingsPtrOutput) ToStageDefaultRouteSettingsPtrOutput() StageDefaultRouteSettingsPtrOutput
- func (o StageDefaultRouteSettingsPtrOutput) ToStageDefaultRouteSettingsPtrOutputWithContext(ctx context.Context) StageDefaultRouteSettingsPtrOutput
- type StageRouteSetting
- type StageRouteSettingArgs
- type StageRouteSettingArray
- type StageRouteSettingArrayInput
- type StageRouteSettingArrayOutput
- func (StageRouteSettingArrayOutput) ElementType() reflect.Type
- func (o StageRouteSettingArrayOutput) Index(i pulumi.IntInput) StageRouteSettingOutput
- func (o StageRouteSettingArrayOutput) ToStageRouteSettingArrayOutput() StageRouteSettingArrayOutput
- func (o StageRouteSettingArrayOutput) ToStageRouteSettingArrayOutputWithContext(ctx context.Context) StageRouteSettingArrayOutput
- type StageRouteSettingInput
- type StageRouteSettingOutput
- func (o StageRouteSettingOutput) DataTraceEnabled() pulumi.BoolPtrOutput
- func (o StageRouteSettingOutput) DetailedMetricsEnabled() pulumi.BoolPtrOutput
- func (StageRouteSettingOutput) ElementType() reflect.Type
- func (o StageRouteSettingOutput) LoggingLevel() pulumi.StringPtrOutput
- func (o StageRouteSettingOutput) RouteKey() pulumi.StringOutput
- func (o StageRouteSettingOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput
- func (o StageRouteSettingOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput
- func (o StageRouteSettingOutput) ToStageRouteSettingOutput() StageRouteSettingOutput
- func (o StageRouteSettingOutput) ToStageRouteSettingOutputWithContext(ctx context.Context) StageRouteSettingOutput
- type StageState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Api ¶
type Api struct { pulumi.CustomResourceState // The URI of the API, of the form `{api-id}.execute-api.{region}.amazonaws.com`. ApiEndpoint pulumi.StringOutput `pulumi:"apiEndpoint"` // An [API key selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). // Valid values: `$context.authorizer.usageIdentifierKey`, `$request.header.x-api-key`. Defaults to `$request.header.x-api-key`. // Applicable for WebSocket APIs. ApiKeySelectionExpression pulumi.StringPtrOutput `pulumi:"apiKeySelectionExpression"` // The ARN of the API. Arn pulumi.StringOutput `pulumi:"arn"` // The description of the API. Description pulumi.StringPtrOutput `pulumi:"description"` // The ARN prefix to be used in an [`lambda.Permission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn` attribute // or in an [`iam.Policy`](https://www.terraform.io/docs/providers/aws/r/iam_policy.html) to authorize access to the [`@connections` API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html). // See the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-control-access-iam.html) for details. ExecutionArn pulumi.StringOutput `pulumi:"executionArn"` // The name of the API. Name pulumi.StringOutput `pulumi:"name"` // The API protocol. Valid values: `HTTP`, `WEBSOCKET`. ProtocolType pulumi.StringOutput `pulumi:"protocolType"` // The [route selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-route-selection-expressions) for the API. // Defaults to `$request.method $request.path`. RouteSelectionExpression pulumi.StringPtrOutput `pulumi:"routeSelectionExpression"` // A mapping of tags to assign to the API. Tags pulumi.MapOutput `pulumi:"tags"` // A version identifier for the API. Version pulumi.StringPtrOutput `pulumi:"version"` }
Manages an Amazon API Gateway Version 2 API.
> **Note:** Amazon API Gateway Version 2 resources are used for creating and deploying WebSocket and HTTP APIs. To create and deploy REST APIs, use Amazon API Gateway Version 1.
func GetApi ¶
func GetApi(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ApiState, opts ...pulumi.ResourceOption) (*Api, error)
GetApi gets an existing Api resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
type ApiArgs ¶
type ApiArgs struct { // An [API key selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). // Valid values: `$context.authorizer.usageIdentifierKey`, `$request.header.x-api-key`. Defaults to `$request.header.x-api-key`. // Applicable for WebSocket APIs. ApiKeySelectionExpression pulumi.StringPtrInput // The description of the API. Description pulumi.StringPtrInput // The name of the API. Name pulumi.StringPtrInput // The API protocol. Valid values: `HTTP`, `WEBSOCKET`. ProtocolType pulumi.StringInput // The [route selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-route-selection-expressions) for the API. // Defaults to `$request.method $request.path`. RouteSelectionExpression pulumi.StringPtrInput // A mapping of tags to assign to the API. Tags pulumi.MapInput // A version identifier for the API. Version pulumi.StringPtrInput }
The set of arguments for constructing a Api resource.
func (ApiArgs) ElementType ¶
type ApiState ¶
type ApiState struct { // The URI of the API, of the form `{api-id}.execute-api.{region}.amazonaws.com`. ApiEndpoint pulumi.StringPtrInput // An [API key selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). // Valid values: `$context.authorizer.usageIdentifierKey`, `$request.header.x-api-key`. Defaults to `$request.header.x-api-key`. // Applicable for WebSocket APIs. ApiKeySelectionExpression pulumi.StringPtrInput // The ARN of the API. Arn pulumi.StringPtrInput // The description of the API. Description pulumi.StringPtrInput // The ARN prefix to be used in an [`lambda.Permission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn` attribute // or in an [`iam.Policy`](https://www.terraform.io/docs/providers/aws/r/iam_policy.html) to authorize access to the [`@connections` API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html). // See the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-control-access-iam.html) for details. ExecutionArn pulumi.StringPtrInput // The name of the API. Name pulumi.StringPtrInput // The API protocol. Valid values: `HTTP`, `WEBSOCKET`. ProtocolType pulumi.StringPtrInput // The [route selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-route-selection-expressions) for the API. // Defaults to `$request.method $request.path`. RouteSelectionExpression pulumi.StringPtrInput // A mapping of tags to assign to the API. Tags pulumi.MapInput // A version identifier for the API. Version pulumi.StringPtrInput }
func (ApiState) ElementType ¶
type Authorizer ¶
type Authorizer struct { pulumi.CustomResourceState // The API identifier. ApiId pulumi.StringOutput `pulumi:"apiId"` // The required credentials as an IAM role for API Gateway to invoke the authorizer. // Supported only for `REQUEST` authorizers. AuthorizerCredentialsArn pulumi.StringPtrOutput `pulumi:"authorizerCredentialsArn"` // The authorizer type. Valid values: `JWT`, `REQUEST`. // For WebSocket APIs, specify `REQUEST` for a Lambda function using incoming request parameters. // For HTTP APIs, specify `JWT` to use JSON Web Tokens. AuthorizerType pulumi.StringOutput `pulumi:"authorizerType"` // The authorizer's Uniform Resource Identifier (URI). // For `REQUEST` authorizers this must be a well-formed Lambda function URI, such as the `invokeArn` attribute of the [`lambda.Function`](https://www.terraform.io/docs/providers/aws/r/lambda_function.html) resource. // Supported only for `REQUEST` authorizers. AuthorizerUri pulumi.StringPtrOutput `pulumi:"authorizerUri"` // The identity sources for which authorization is requested. // For `REQUEST` authorizers the value is a list of one or more mapping expressions of the specified request parameters. // For `JWT` authorizers the single entry specifies where to extract the JSON Web Token (JWT) from inbound requests. IdentitySources pulumi.StringArrayOutput `pulumi:"identitySources"` // The configuration of a JWT authorizer. Required for the `JWT` authorizer type. // Supported only for HTTP APIs. JwtConfiguration AuthorizerJwtConfigurationPtrOutput `pulumi:"jwtConfiguration"` // The name of the authorizer. Name pulumi.StringOutput `pulumi:"name"` }
Manages an Amazon API Gateway Version 2 authorizer. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html).
func GetAuthorizer ¶
func GetAuthorizer(ctx *pulumi.Context, name string, id pulumi.IDInput, state *AuthorizerState, opts ...pulumi.ResourceOption) (*Authorizer, error)
GetAuthorizer gets an existing Authorizer resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewAuthorizer ¶
func NewAuthorizer(ctx *pulumi.Context, name string, args *AuthorizerArgs, opts ...pulumi.ResourceOption) (*Authorizer, error)
NewAuthorizer registers a new resource with the given unique name, arguments, and options.
type AuthorizerArgs ¶
type AuthorizerArgs struct { // The API identifier. ApiId pulumi.StringInput // The required credentials as an IAM role for API Gateway to invoke the authorizer. // Supported only for `REQUEST` authorizers. AuthorizerCredentialsArn pulumi.StringPtrInput // The authorizer type. Valid values: `JWT`, `REQUEST`. // For WebSocket APIs, specify `REQUEST` for a Lambda function using incoming request parameters. // For HTTP APIs, specify `JWT` to use JSON Web Tokens. AuthorizerType pulumi.StringInput // The authorizer's Uniform Resource Identifier (URI). // For `REQUEST` authorizers this must be a well-formed Lambda function URI, such as the `invokeArn` attribute of the [`lambda.Function`](https://www.terraform.io/docs/providers/aws/r/lambda_function.html) resource. // Supported only for `REQUEST` authorizers. AuthorizerUri pulumi.StringPtrInput // The identity sources for which authorization is requested. // For `REQUEST` authorizers the value is a list of one or more mapping expressions of the specified request parameters. // For `JWT` authorizers the single entry specifies where to extract the JSON Web Token (JWT) from inbound requests. IdentitySources pulumi.StringArrayInput // The configuration of a JWT authorizer. Required for the `JWT` authorizer type. // Supported only for HTTP APIs. JwtConfiguration AuthorizerJwtConfigurationPtrInput // The name of the authorizer. Name pulumi.StringPtrInput }
The set of arguments for constructing a Authorizer resource.
func (AuthorizerArgs) ElementType ¶
func (AuthorizerArgs) ElementType() reflect.Type
type AuthorizerJwtConfiguration ¶
type AuthorizerJwtConfiguration struct { // A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. Audiences []string `pulumi:"audiences"` // The base domain of the identity provider that issues JSON Web Tokens, such as the `endpoint` attribute of the [`cognito.UserPool`](https://www.terraform.io/docs/providers/aws/r/cognito_user_pool.html) resource. Issuer *string `pulumi:"issuer"` }
type AuthorizerJwtConfigurationArgs ¶
type AuthorizerJwtConfigurationArgs struct { // A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. Audiences pulumi.StringArrayInput `pulumi:"audiences"` // The base domain of the identity provider that issues JSON Web Tokens, such as the `endpoint` attribute of the [`cognito.UserPool`](https://www.terraform.io/docs/providers/aws/r/cognito_user_pool.html) resource. Issuer pulumi.StringPtrInput `pulumi:"issuer"` }
func (AuthorizerJwtConfigurationArgs) ElementType ¶
func (AuthorizerJwtConfigurationArgs) ElementType() reflect.Type
func (AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutput ¶
func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutput() AuthorizerJwtConfigurationOutput
func (AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutputWithContext ¶
func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationOutput
func (AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutput ¶
func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput
func (AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutputWithContext ¶
func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationPtrOutput
type AuthorizerJwtConfigurationInput ¶
type AuthorizerJwtConfigurationInput interface { pulumi.Input ToAuthorizerJwtConfigurationOutput() AuthorizerJwtConfigurationOutput ToAuthorizerJwtConfigurationOutputWithContext(context.Context) AuthorizerJwtConfigurationOutput }
AuthorizerJwtConfigurationInput is an input type that accepts AuthorizerJwtConfigurationArgs and AuthorizerJwtConfigurationOutput values. You can construct a concrete instance of `AuthorizerJwtConfigurationInput` via:
AuthorizerJwtConfigurationArgs{...}
type AuthorizerJwtConfigurationOutput ¶
type AuthorizerJwtConfigurationOutput struct{ *pulumi.OutputState }
func (AuthorizerJwtConfigurationOutput) Audiences ¶
func (o AuthorizerJwtConfigurationOutput) Audiences() pulumi.StringArrayOutput
A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list.
func (AuthorizerJwtConfigurationOutput) ElementType ¶
func (AuthorizerJwtConfigurationOutput) ElementType() reflect.Type
func (AuthorizerJwtConfigurationOutput) Issuer ¶
func (o AuthorizerJwtConfigurationOutput) Issuer() pulumi.StringPtrOutput
The base domain of the identity provider that issues JSON Web Tokens, such as the `endpoint` attribute of the [`cognito.UserPool`](https://www.terraform.io/docs/providers/aws/r/cognito_user_pool.html) resource.
func (AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutput ¶
func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutput() AuthorizerJwtConfigurationOutput
func (AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutputWithContext ¶
func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationOutput
func (AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutput ¶
func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput
func (AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext ¶
func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationPtrOutput
type AuthorizerJwtConfigurationPtrInput ¶
type AuthorizerJwtConfigurationPtrInput interface { pulumi.Input ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput ToAuthorizerJwtConfigurationPtrOutputWithContext(context.Context) AuthorizerJwtConfigurationPtrOutput }
AuthorizerJwtConfigurationPtrInput is an input type that accepts AuthorizerJwtConfigurationArgs, AuthorizerJwtConfigurationPtr and AuthorizerJwtConfigurationPtrOutput values. You can construct a concrete instance of `AuthorizerJwtConfigurationPtrInput` via:
AuthorizerJwtConfigurationArgs{...} or: nil
func AuthorizerJwtConfigurationPtr ¶
func AuthorizerJwtConfigurationPtr(v *AuthorizerJwtConfigurationArgs) AuthorizerJwtConfigurationPtrInput
type AuthorizerJwtConfigurationPtrOutput ¶
type AuthorizerJwtConfigurationPtrOutput struct{ *pulumi.OutputState }
func (AuthorizerJwtConfigurationPtrOutput) Audiences ¶
func (o AuthorizerJwtConfigurationPtrOutput) Audiences() pulumi.StringArrayOutput
A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list.
func (AuthorizerJwtConfigurationPtrOutput) Elem ¶
func (o AuthorizerJwtConfigurationPtrOutput) Elem() AuthorizerJwtConfigurationOutput
func (AuthorizerJwtConfigurationPtrOutput) ElementType ¶
func (AuthorizerJwtConfigurationPtrOutput) ElementType() reflect.Type
func (AuthorizerJwtConfigurationPtrOutput) Issuer ¶
func (o AuthorizerJwtConfigurationPtrOutput) Issuer() pulumi.StringPtrOutput
The base domain of the identity provider that issues JSON Web Tokens, such as the `endpoint` attribute of the [`cognito.UserPool`](https://www.terraform.io/docs/providers/aws/r/cognito_user_pool.html) resource.
func (AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutput ¶
func (o AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput
func (AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext ¶
func (o AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationPtrOutput
type AuthorizerState ¶
type AuthorizerState struct { // The API identifier. ApiId pulumi.StringPtrInput // The required credentials as an IAM role for API Gateway to invoke the authorizer. // Supported only for `REQUEST` authorizers. AuthorizerCredentialsArn pulumi.StringPtrInput // The authorizer type. Valid values: `JWT`, `REQUEST`. // For WebSocket APIs, specify `REQUEST` for a Lambda function using incoming request parameters. // For HTTP APIs, specify `JWT` to use JSON Web Tokens. AuthorizerType pulumi.StringPtrInput // The authorizer's Uniform Resource Identifier (URI). // For `REQUEST` authorizers this must be a well-formed Lambda function URI, such as the `invokeArn` attribute of the [`lambda.Function`](https://www.terraform.io/docs/providers/aws/r/lambda_function.html) resource. // Supported only for `REQUEST` authorizers. AuthorizerUri pulumi.StringPtrInput // The identity sources for which authorization is requested. // For `REQUEST` authorizers the value is a list of one or more mapping expressions of the specified request parameters. // For `JWT` authorizers the single entry specifies where to extract the JSON Web Token (JWT) from inbound requests. IdentitySources pulumi.StringArrayInput // The configuration of a JWT authorizer. Required for the `JWT` authorizer type. // Supported only for HTTP APIs. JwtConfiguration AuthorizerJwtConfigurationPtrInput // The name of the authorizer. Name pulumi.StringPtrInput }
func (AuthorizerState) ElementType ¶
func (AuthorizerState) ElementType() reflect.Type
type Deployment ¶ added in v2.1.0
type Deployment struct { pulumi.CustomResourceState // The API identifier. ApiId pulumi.StringOutput `pulumi:"apiId"` // Whether the deployment was automatically released. AutoDeployed pulumi.BoolOutput `pulumi:"autoDeployed"` // The description for the deployment resource. Description pulumi.StringPtrOutput `pulumi:"description"` }
Manages an Amazon API Gateway Version 2 deployment. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html).
> **Note:** Creating a deployment for an API requires at least one `apigatewayv2.Route` resource associated with that API.
func GetDeployment ¶ added in v2.1.0
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 ¶ added in v2.1.0
func NewDeployment(ctx *pulumi.Context, name string, args *DeploymentArgs, opts ...pulumi.ResourceOption) (*Deployment, error)
NewDeployment registers a new resource with the given unique name, arguments, and options.
type DeploymentArgs ¶ added in v2.1.0
type DeploymentArgs struct { // The API identifier. ApiId pulumi.StringInput // The description for the deployment resource. Description pulumi.StringPtrInput }
The set of arguments for constructing a Deployment resource.
func (DeploymentArgs) ElementType ¶ added in v2.1.0
func (DeploymentArgs) ElementType() reflect.Type
type DeploymentState ¶ added in v2.1.0
type DeploymentState struct { // The API identifier. ApiId pulumi.StringPtrInput // Whether the deployment was automatically released. AutoDeployed pulumi.BoolPtrInput // The description for the deployment resource. Description pulumi.StringPtrInput }
func (DeploymentState) ElementType ¶ added in v2.1.0
func (DeploymentState) ElementType() reflect.Type
type DomainName ¶ added in v2.1.0
type DomainName struct { pulumi.CustomResourceState // The [API mapping selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-mapping-selection-expressions) for the domain name. ApiMappingSelectionExpression pulumi.StringOutput `pulumi:"apiMappingSelectionExpression"` // The ARN of the domain name. Arn pulumi.StringOutput `pulumi:"arn"` // The domain name. DomainName pulumi.StringOutput `pulumi:"domainName"` // The domain name configuration. DomainNameConfiguration DomainNameDomainNameConfigurationOutput `pulumi:"domainNameConfiguration"` // A mapping of tags to assign to the domain name. Tags pulumi.MapOutput `pulumi:"tags"` }
Manages an Amazon API Gateway Version 2 domain name. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html).
> **Note:** This resource establishes ownership of and the TLS settings for a particular domain name. An API stage can be associated with the domain name using the `awsApigatewayv2ApiMapping` resource.
func GetDomainName ¶ added in v2.1.0
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 ¶ added in v2.1.0
func NewDomainName(ctx *pulumi.Context, name string, args *DomainNameArgs, opts ...pulumi.ResourceOption) (*DomainName, error)
NewDomainName registers a new resource with the given unique name, arguments, and options.
type DomainNameArgs ¶ added in v2.1.0
type DomainNameArgs struct { // The domain name. DomainName pulumi.StringInput // The domain name configuration. DomainNameConfiguration DomainNameDomainNameConfigurationInput // A mapping of tags to assign to the domain name. Tags pulumi.MapInput }
The set of arguments for constructing a DomainName resource.
func (DomainNameArgs) ElementType ¶ added in v2.1.0
func (DomainNameArgs) ElementType() reflect.Type
type DomainNameDomainNameConfiguration ¶ added in v2.1.0
type DomainNameDomainNameConfiguration struct { // The ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. // Use the [`acm.Certificate`](https://www.terraform.io/docs/providers/aws/r/acm_certificate.html) resource to configure an ACM certificate. CertificateArn string `pulumi:"certificateArn"` // The endpoint type. Valid values: `REGIONAL`. EndpointType string `pulumi:"endpointType"` // The Amazon Route 53 Hosted Zone ID of the endpoint. HostedZoneId *string `pulumi:"hostedZoneId"` // The Transport Layer Security (TLS) version of the [security policy](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html) for the domain name. Valid values: `TLS_1_2`. SecurityPolicy string `pulumi:"securityPolicy"` // The target domain name. TargetDomainName *string `pulumi:"targetDomainName"` }
type DomainNameDomainNameConfigurationArgs ¶ added in v2.1.0
type DomainNameDomainNameConfigurationArgs struct { // The ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. // Use the [`acm.Certificate`](https://www.terraform.io/docs/providers/aws/r/acm_certificate.html) resource to configure an ACM certificate. CertificateArn pulumi.StringInput `pulumi:"certificateArn"` // The endpoint type. Valid values: `REGIONAL`. EndpointType pulumi.StringInput `pulumi:"endpointType"` // The Amazon Route 53 Hosted Zone ID of the endpoint. HostedZoneId pulumi.StringPtrInput `pulumi:"hostedZoneId"` // The Transport Layer Security (TLS) version of the [security policy](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html) for the domain name. Valid values: `TLS_1_2`. SecurityPolicy pulumi.StringInput `pulumi:"securityPolicy"` // The target domain name. TargetDomainName pulumi.StringPtrInput `pulumi:"targetDomainName"` }
func (DomainNameDomainNameConfigurationArgs) ElementType ¶ added in v2.1.0
func (DomainNameDomainNameConfigurationArgs) ElementType() reflect.Type
func (DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationOutput ¶ added in v2.1.0
func (i DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationOutput() DomainNameDomainNameConfigurationOutput
func (DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationOutputWithContext ¶ added in v2.1.0
func (i DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationOutput
func (DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationPtrOutput ¶ added in v2.1.0
func (i DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationPtrOutput() DomainNameDomainNameConfigurationPtrOutput
func (DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationPtrOutputWithContext ¶ added in v2.1.0
func (i DomainNameDomainNameConfigurationArgs) ToDomainNameDomainNameConfigurationPtrOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationPtrOutput
type DomainNameDomainNameConfigurationInput ¶ added in v2.1.0
type DomainNameDomainNameConfigurationInput interface { pulumi.Input ToDomainNameDomainNameConfigurationOutput() DomainNameDomainNameConfigurationOutput ToDomainNameDomainNameConfigurationOutputWithContext(context.Context) DomainNameDomainNameConfigurationOutput }
DomainNameDomainNameConfigurationInput is an input type that accepts DomainNameDomainNameConfigurationArgs and DomainNameDomainNameConfigurationOutput values. You can construct a concrete instance of `DomainNameDomainNameConfigurationInput` via:
DomainNameDomainNameConfigurationArgs{...}
type DomainNameDomainNameConfigurationOutput ¶ added in v2.1.0
type DomainNameDomainNameConfigurationOutput struct{ *pulumi.OutputState }
func (DomainNameDomainNameConfigurationOutput) CertificateArn ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationOutput) CertificateArn() pulumi.StringOutput
The ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. Use the [`acm.Certificate`](https://www.terraform.io/docs/providers/aws/r/acm_certificate.html) resource to configure an ACM certificate.
func (DomainNameDomainNameConfigurationOutput) ElementType ¶ added in v2.1.0
func (DomainNameDomainNameConfigurationOutput) ElementType() reflect.Type
func (DomainNameDomainNameConfigurationOutput) EndpointType ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationOutput) EndpointType() pulumi.StringOutput
The endpoint type. Valid values: `REGIONAL`.
func (DomainNameDomainNameConfigurationOutput) HostedZoneId ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationOutput) HostedZoneId() pulumi.StringPtrOutput
The Amazon Route 53 Hosted Zone ID of the endpoint.
func (DomainNameDomainNameConfigurationOutput) SecurityPolicy ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationOutput) SecurityPolicy() pulumi.StringOutput
The Transport Layer Security (TLS) version of the [security policy](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html) for the domain name. Valid values: `TLS_1_2`.
func (DomainNameDomainNameConfigurationOutput) TargetDomainName ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationOutput) TargetDomainName() pulumi.StringPtrOutput
The target domain name.
func (DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationOutput ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationOutput() DomainNameDomainNameConfigurationOutput
func (DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationOutputWithContext ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationOutput
func (DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationPtrOutput ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationPtrOutput() DomainNameDomainNameConfigurationPtrOutput
func (DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationPtrOutputWithContext ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationOutput) ToDomainNameDomainNameConfigurationPtrOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationPtrOutput
type DomainNameDomainNameConfigurationPtrInput ¶ added in v2.1.0
type DomainNameDomainNameConfigurationPtrInput interface { pulumi.Input ToDomainNameDomainNameConfigurationPtrOutput() DomainNameDomainNameConfigurationPtrOutput ToDomainNameDomainNameConfigurationPtrOutputWithContext(context.Context) DomainNameDomainNameConfigurationPtrOutput }
DomainNameDomainNameConfigurationPtrInput is an input type that accepts DomainNameDomainNameConfigurationArgs, DomainNameDomainNameConfigurationPtr and DomainNameDomainNameConfigurationPtrOutput values. You can construct a concrete instance of `DomainNameDomainNameConfigurationPtrInput` via:
DomainNameDomainNameConfigurationArgs{...} or: nil
func DomainNameDomainNameConfigurationPtr ¶ added in v2.1.0
func DomainNameDomainNameConfigurationPtr(v *DomainNameDomainNameConfigurationArgs) DomainNameDomainNameConfigurationPtrInput
type DomainNameDomainNameConfigurationPtrOutput ¶ added in v2.1.0
type DomainNameDomainNameConfigurationPtrOutput struct{ *pulumi.OutputState }
func (DomainNameDomainNameConfigurationPtrOutput) CertificateArn ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationPtrOutput) CertificateArn() pulumi.StringPtrOutput
The ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source. Use the [`acm.Certificate`](https://www.terraform.io/docs/providers/aws/r/acm_certificate.html) resource to configure an ACM certificate.
func (DomainNameDomainNameConfigurationPtrOutput) ElementType ¶ added in v2.1.0
func (DomainNameDomainNameConfigurationPtrOutput) ElementType() reflect.Type
func (DomainNameDomainNameConfigurationPtrOutput) EndpointType ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationPtrOutput) EndpointType() pulumi.StringPtrOutput
The endpoint type. Valid values: `REGIONAL`.
func (DomainNameDomainNameConfigurationPtrOutput) HostedZoneId ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationPtrOutput) HostedZoneId() pulumi.StringPtrOutput
The Amazon Route 53 Hosted Zone ID of the endpoint.
func (DomainNameDomainNameConfigurationPtrOutput) SecurityPolicy ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationPtrOutput) SecurityPolicy() pulumi.StringPtrOutput
The Transport Layer Security (TLS) version of the [security policy](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html) for the domain name. Valid values: `TLS_1_2`.
func (DomainNameDomainNameConfigurationPtrOutput) TargetDomainName ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationPtrOutput) TargetDomainName() pulumi.StringPtrOutput
The target domain name.
func (DomainNameDomainNameConfigurationPtrOutput) ToDomainNameDomainNameConfigurationPtrOutput ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationPtrOutput) ToDomainNameDomainNameConfigurationPtrOutput() DomainNameDomainNameConfigurationPtrOutput
func (DomainNameDomainNameConfigurationPtrOutput) ToDomainNameDomainNameConfigurationPtrOutputWithContext ¶ added in v2.1.0
func (o DomainNameDomainNameConfigurationPtrOutput) ToDomainNameDomainNameConfigurationPtrOutputWithContext(ctx context.Context) DomainNameDomainNameConfigurationPtrOutput
type DomainNameState ¶ added in v2.1.0
type DomainNameState struct { // The [API mapping selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-mapping-selection-expressions) for the domain name. ApiMappingSelectionExpression pulumi.StringPtrInput // The ARN of the domain name. Arn pulumi.StringPtrInput // The domain name. DomainName pulumi.StringPtrInput // The domain name configuration. DomainNameConfiguration DomainNameDomainNameConfigurationPtrInput // A mapping of tags to assign to the domain name. Tags pulumi.MapInput }
func (DomainNameState) ElementType ¶ added in v2.1.0
func (DomainNameState) ElementType() reflect.Type
type Integration ¶
type Integration struct { pulumi.CustomResourceState // The API identifier. ApiId pulumi.StringOutput `pulumi:"apiId"` // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId pulumi.StringPtrOutput `pulumi:"connectionId"` // The type of the network connection to the integration endpoint. Valid values: `INTERNET`, `VPC_LINK`. Default is `INTERNET`. ConnectionType pulumi.StringPtrOutput `pulumi:"connectionType"` // How to handle response payload content type conversions. Valid values: `CONVERT_TO_BINARY`, `CONVERT_TO_TEXT`. Supported only for WebSocket APIs. ContentHandlingStrategy pulumi.StringPtrOutput `pulumi:"contentHandlingStrategy"` // The credentials required for the integration, if any. CredentialsArn pulumi.StringPtrOutput `pulumi:"credentialsArn"` // The description of the integration. Description pulumi.StringPtrOutput `pulumi:"description"` // The integration's HTTP method. Must be specified if `integrationType` is not `MOCK`. IntegrationMethod pulumi.StringPtrOutput `pulumi:"integrationMethod"` // The [integration response selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions) for the integration. IntegrationResponseSelectionExpression pulumi.StringOutput `pulumi:"integrationResponseSelectionExpression"` // The integration type of an integration. // Valid values: `AWS`, `AWS_PROXY`, `HTTP`, `HTTP_PROXY`, `MOCK`. IntegrationType pulumi.StringOutput `pulumi:"integrationType"` // The URI of the Lambda function for a Lambda proxy integration, when `integrationType` is `AWS_PROXY`. // For an `HTTP` integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. IntegrationUri pulumi.StringPtrOutput `pulumi:"integrationUri"` // The pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the `requestTemplates` attribute. // Valid values: `WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, `NEVER`. Default is `WHEN_NO_MATCH`. Supported only for WebSocket APIs. PassthroughBehavior pulumi.StringPtrOutput `pulumi:"passthroughBehavior"` // The [format of the payload](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html#http-api-develop-integrations-lambda.proxy-format) sent to an integration. Valid values: `1.0`, `2.0`. Default is `1.0`. PayloadFormatVersion pulumi.StringPtrOutput `pulumi:"payloadFormatVersion"` // A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. Supported only for WebSocket APIs. RequestTemplates pulumi.StringMapOutput `pulumi:"requestTemplates"` // The [template selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-template-selection-expressions) for the integration. TemplateSelectionExpression pulumi.StringPtrOutput `pulumi:"templateSelectionExpression"` // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. TimeoutMilliseconds pulumi.IntPtrOutput `pulumi:"timeoutMilliseconds"` }
Manages an Amazon API Gateway Version 2 integration. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html).
func GetIntegration ¶
func GetIntegration(ctx *pulumi.Context, name string, id pulumi.IDInput, state *IntegrationState, opts ...pulumi.ResourceOption) (*Integration, error)
GetIntegration gets an existing Integration resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewIntegration ¶
func NewIntegration(ctx *pulumi.Context, name string, args *IntegrationArgs, opts ...pulumi.ResourceOption) (*Integration, error)
NewIntegration registers a new resource with the given unique name, arguments, and options.
type IntegrationArgs ¶
type IntegrationArgs struct { // The API identifier. ApiId pulumi.StringInput // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId pulumi.StringPtrInput // The type of the network connection to the integration endpoint. Valid values: `INTERNET`, `VPC_LINK`. Default is `INTERNET`. ConnectionType pulumi.StringPtrInput // How to handle response payload content type conversions. Valid values: `CONVERT_TO_BINARY`, `CONVERT_TO_TEXT`. Supported only for WebSocket APIs. ContentHandlingStrategy pulumi.StringPtrInput // The credentials required for the integration, if any. CredentialsArn pulumi.StringPtrInput // The description of the integration. Description pulumi.StringPtrInput // The integration's HTTP method. Must be specified if `integrationType` is not `MOCK`. IntegrationMethod pulumi.StringPtrInput // The integration type of an integration. // Valid values: `AWS`, `AWS_PROXY`, `HTTP`, `HTTP_PROXY`, `MOCK`. IntegrationType pulumi.StringInput // The URI of the Lambda function for a Lambda proxy integration, when `integrationType` is `AWS_PROXY`. // For an `HTTP` integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. IntegrationUri pulumi.StringPtrInput // The pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the `requestTemplates` attribute. // Valid values: `WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, `NEVER`. Default is `WHEN_NO_MATCH`. Supported only for WebSocket APIs. PassthroughBehavior pulumi.StringPtrInput // The [format of the payload](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html#http-api-develop-integrations-lambda.proxy-format) sent to an integration. Valid values: `1.0`, `2.0`. Default is `1.0`. PayloadFormatVersion pulumi.StringPtrInput // A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. Supported only for WebSocket APIs. RequestTemplates pulumi.StringMapInput // The [template selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-template-selection-expressions) for the integration. TemplateSelectionExpression pulumi.StringPtrInput // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. TimeoutMilliseconds pulumi.IntPtrInput }
The set of arguments for constructing a Integration resource.
func (IntegrationArgs) ElementType ¶
func (IntegrationArgs) ElementType() reflect.Type
type IntegrationResponse ¶ added in v2.1.0
type IntegrationResponse struct { pulumi.CustomResourceState // The API identifier. ApiId pulumi.StringOutput `pulumi:"apiId"` // How to handle response payload content type conversions. Valid values: `CONVERT_TO_BINARY`, `CONVERT_TO_TEXT`. ContentHandlingStrategy pulumi.StringPtrOutput `pulumi:"contentHandlingStrategy"` // The identifier of the [`apigatewayv2.Integration`](https://www.terraform.io/docs/providers/aws/r/apigatewayv2_integration.html). IntegrationId pulumi.StringOutput `pulumi:"integrationId"` // The integration response key. IntegrationResponseKey pulumi.StringOutput `pulumi:"integrationResponseKey"` // A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. ResponseTemplates pulumi.StringMapOutput `pulumi:"responseTemplates"` // The [template selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-template-selection-expressions) for the integration response. TemplateSelectionExpression pulumi.StringPtrOutput `pulumi:"templateSelectionExpression"` }
Manages an Amazon API Gateway Version 2 integration response. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html).
func GetIntegrationResponse ¶ added in v2.1.0
func GetIntegrationResponse(ctx *pulumi.Context, name string, id pulumi.IDInput, state *IntegrationResponseState, opts ...pulumi.ResourceOption) (*IntegrationResponse, error)
GetIntegrationResponse gets an existing IntegrationResponse resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewIntegrationResponse ¶ added in v2.1.0
func NewIntegrationResponse(ctx *pulumi.Context, name string, args *IntegrationResponseArgs, opts ...pulumi.ResourceOption) (*IntegrationResponse, error)
NewIntegrationResponse registers a new resource with the given unique name, arguments, and options.
type IntegrationResponseArgs ¶ added in v2.1.0
type IntegrationResponseArgs struct { // The API identifier. ApiId pulumi.StringInput // How to handle response payload content type conversions. Valid values: `CONVERT_TO_BINARY`, `CONVERT_TO_TEXT`. ContentHandlingStrategy pulumi.StringPtrInput // The identifier of the [`apigatewayv2.Integration`](https://www.terraform.io/docs/providers/aws/r/apigatewayv2_integration.html). IntegrationId pulumi.StringInput // The integration response key. IntegrationResponseKey pulumi.StringInput // A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. ResponseTemplates pulumi.StringMapInput // The [template selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-template-selection-expressions) for the integration response. TemplateSelectionExpression pulumi.StringPtrInput }
The set of arguments for constructing a IntegrationResponse resource.
func (IntegrationResponseArgs) ElementType ¶ added in v2.1.0
func (IntegrationResponseArgs) ElementType() reflect.Type
type IntegrationResponseState ¶ added in v2.1.0
type IntegrationResponseState struct { // The API identifier. ApiId pulumi.StringPtrInput // How to handle response payload content type conversions. Valid values: `CONVERT_TO_BINARY`, `CONVERT_TO_TEXT`. ContentHandlingStrategy pulumi.StringPtrInput // The identifier of the [`apigatewayv2.Integration`](https://www.terraform.io/docs/providers/aws/r/apigatewayv2_integration.html). IntegrationId pulumi.StringPtrInput // The integration response key. IntegrationResponseKey pulumi.StringPtrInput // A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. ResponseTemplates pulumi.StringMapInput // The [template selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-template-selection-expressions) for the integration response. TemplateSelectionExpression pulumi.StringPtrInput }
func (IntegrationResponseState) ElementType ¶ added in v2.1.0
func (IntegrationResponseState) ElementType() reflect.Type
type IntegrationState ¶
type IntegrationState struct { // The API identifier. ApiId pulumi.StringPtrInput // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId pulumi.StringPtrInput // The type of the network connection to the integration endpoint. Valid values: `INTERNET`, `VPC_LINK`. Default is `INTERNET`. ConnectionType pulumi.StringPtrInput // How to handle response payload content type conversions. Valid values: `CONVERT_TO_BINARY`, `CONVERT_TO_TEXT`. Supported only for WebSocket APIs. ContentHandlingStrategy pulumi.StringPtrInput // The credentials required for the integration, if any. CredentialsArn pulumi.StringPtrInput // The description of the integration. Description pulumi.StringPtrInput // The integration's HTTP method. Must be specified if `integrationType` is not `MOCK`. IntegrationMethod pulumi.StringPtrInput // The [integration response selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions) for the integration. IntegrationResponseSelectionExpression pulumi.StringPtrInput // The integration type of an integration. // Valid values: `AWS`, `AWS_PROXY`, `HTTP`, `HTTP_PROXY`, `MOCK`. IntegrationType pulumi.StringPtrInput // The URI of the Lambda function for a Lambda proxy integration, when `integrationType` is `AWS_PROXY`. // For an `HTTP` integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. IntegrationUri pulumi.StringPtrInput // The pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the `requestTemplates` attribute. // Valid values: `WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, `NEVER`. Default is `WHEN_NO_MATCH`. Supported only for WebSocket APIs. PassthroughBehavior pulumi.StringPtrInput // The [format of the payload](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html#http-api-develop-integrations-lambda.proxy-format) sent to an integration. Valid values: `1.0`, `2.0`. Default is `1.0`. PayloadFormatVersion pulumi.StringPtrInput // A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. Supported only for WebSocket APIs. RequestTemplates pulumi.StringMapInput // The [template selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-template-selection-expressions) for the integration. TemplateSelectionExpression pulumi.StringPtrInput // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. TimeoutMilliseconds pulumi.IntPtrInput }
func (IntegrationState) ElementType ¶
func (IntegrationState) ElementType() reflect.Type
type Model ¶
type Model struct { pulumi.CustomResourceState // The API identifier. ApiId pulumi.StringOutput `pulumi:"apiId"` // The content-type for the model, for example, `application/json`. ContentType pulumi.StringOutput `pulumi:"contentType"` // The description of the model. Description pulumi.StringPtrOutput `pulumi:"description"` // The name of the model. Must be alphanumeric. Name pulumi.StringOutput `pulumi:"name"` // The schema for the model. This should be a [JSON schema draft 4](https://tools.ietf.org/html/draft-zyp-json-schema-04) model. Schema pulumi.StringOutput `pulumi:"schema"` }
Manages an Amazon API Gateway Version 2 [model](https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-models).
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).
type ModelArgs ¶
type ModelArgs struct { // The API identifier. ApiId pulumi.StringInput // The content-type for the model, for example, `application/json`. ContentType pulumi.StringInput // The description of the model. Description pulumi.StringPtrInput // The name of the model. Must be alphanumeric. Name pulumi.StringPtrInput // The schema for the model. This should be a [JSON schema draft 4](https://tools.ietf.org/html/draft-zyp-json-schema-04) model. Schema pulumi.StringInput }
The set of arguments for constructing a Model resource.
func (ModelArgs) ElementType ¶
type ModelState ¶
type ModelState struct { // The API identifier. ApiId pulumi.StringPtrInput // The content-type for the model, for example, `application/json`. ContentType pulumi.StringPtrInput // The description of the model. Description pulumi.StringPtrInput // The name of the model. Must be alphanumeric. Name pulumi.StringPtrInput // The schema for the model. This should be a [JSON schema draft 4](https://tools.ietf.org/html/draft-zyp-json-schema-04) model. Schema pulumi.StringPtrInput }
func (ModelState) ElementType ¶
func (ModelState) ElementType() reflect.Type
type Route ¶ added in v2.1.0
type Route struct { pulumi.CustomResourceState // The API identifier. ApiId pulumi.StringOutput `pulumi:"apiId"` // Boolean whether an API key is required for the route. Defaults to `false`. ApiKeyRequired pulumi.BoolPtrOutput `pulumi:"apiKeyRequired"` // The authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation. AuthorizationScopes pulumi.StringArrayOutput `pulumi:"authorizationScopes"` // The authorization type for the route. // For WebSocket APIs, valid values are `NONE` for open access, `AWS_IAM` for using AWS IAM permissions, and `CUSTOM` for using a Lambda authorizer. // For HTTP APIs, valid values are `NONE` for open access, or `JWT` for using JSON Web Tokens. // Defaults to `NONE`. AuthorizationType pulumi.StringPtrOutput `pulumi:"authorizationType"` // The identifier of the [`apigatewayv2.Authorizer`](https://www.terraform.io/docs/providers/aws/r/apigatewayv2_authorizer.html) resource to be associated with this route, if the authorizationType is `CUSTOM`. AuthorizerId pulumi.StringPtrOutput `pulumi:"authorizerId"` // The [model selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) for the route. ModelSelectionExpression pulumi.StringPtrOutput `pulumi:"modelSelectionExpression"` // The operation name for the route. OperationName pulumi.StringPtrOutput `pulumi:"operationName"` // The request models for the route. RequestModels pulumi.StringMapOutput `pulumi:"requestModels"` // The route key for the route. RouteKey pulumi.StringOutput `pulumi:"routeKey"` // The [route response selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-route-response-selection-expressions) for the route. RouteResponseSelectionExpression pulumi.StringPtrOutput `pulumi:"routeResponseSelectionExpression"` // The target for the route. Target pulumi.StringPtrOutput `pulumi:"target"` }
Manages an Amazon API Gateway Version 2 route. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html).
func GetRoute ¶ added in v2.1.0
func GetRoute(ctx *pulumi.Context, name string, id pulumi.IDInput, state *RouteState, opts ...pulumi.ResourceOption) (*Route, error)
GetRoute gets an existing Route resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
type RouteArgs ¶ added in v2.1.0
type RouteArgs struct { // The API identifier. ApiId pulumi.StringInput // Boolean whether an API key is required for the route. Defaults to `false`. ApiKeyRequired pulumi.BoolPtrInput // The authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation. AuthorizationScopes pulumi.StringArrayInput // The authorization type for the route. // For WebSocket APIs, valid values are `NONE` for open access, `AWS_IAM` for using AWS IAM permissions, and `CUSTOM` for using a Lambda authorizer. // For HTTP APIs, valid values are `NONE` for open access, or `JWT` for using JSON Web Tokens. // Defaults to `NONE`. AuthorizationType pulumi.StringPtrInput // The identifier of the [`apigatewayv2.Authorizer`](https://www.terraform.io/docs/providers/aws/r/apigatewayv2_authorizer.html) resource to be associated with this route, if the authorizationType is `CUSTOM`. AuthorizerId pulumi.StringPtrInput // The [model selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) for the route. ModelSelectionExpression pulumi.StringPtrInput // The operation name for the route. OperationName pulumi.StringPtrInput // The request models for the route. RequestModels pulumi.StringMapInput // The route key for the route. RouteKey pulumi.StringInput // The [route response selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-route-response-selection-expressions) for the route. RouteResponseSelectionExpression pulumi.StringPtrInput // The target for the route. Target pulumi.StringPtrInput }
The set of arguments for constructing a Route resource.
func (RouteArgs) ElementType ¶ added in v2.1.0
type RouteResponse ¶ added in v2.1.0
type RouteResponse struct { pulumi.CustomResourceState // The API identifier. ApiId pulumi.StringOutput `pulumi:"apiId"` // The [model selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) for the route response. ModelSelectionExpression pulumi.StringPtrOutput `pulumi:"modelSelectionExpression"` // The response models for the route response. ResponseModels pulumi.StringMapOutput `pulumi:"responseModels"` // The identifier of the [`apigatewayv2.Route`](https://www.terraform.io/docs/providers/aws/r/apigatewayv2_route.html). RouteId pulumi.StringOutput `pulumi:"routeId"` // The route response key. RouteResponseKey pulumi.StringOutput `pulumi:"routeResponseKey"` }
Manages an Amazon API Gateway Version 2 route response. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html).
func GetRouteResponse ¶ added in v2.1.0
func GetRouteResponse(ctx *pulumi.Context, name string, id pulumi.IDInput, state *RouteResponseState, opts ...pulumi.ResourceOption) (*RouteResponse, error)
GetRouteResponse gets an existing RouteResponse 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 NewRouteResponse ¶ added in v2.1.0
func NewRouteResponse(ctx *pulumi.Context, name string, args *RouteResponseArgs, opts ...pulumi.ResourceOption) (*RouteResponse, error)
NewRouteResponse registers a new resource with the given unique name, arguments, and options.
type RouteResponseArgs ¶ added in v2.1.0
type RouteResponseArgs struct { // The API identifier. ApiId pulumi.StringInput // The [model selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) for the route response. ModelSelectionExpression pulumi.StringPtrInput // The response models for the route response. ResponseModels pulumi.StringMapInput // The identifier of the [`apigatewayv2.Route`](https://www.terraform.io/docs/providers/aws/r/apigatewayv2_route.html). RouteId pulumi.StringInput // The route response key. RouteResponseKey pulumi.StringInput }
The set of arguments for constructing a RouteResponse resource.
func (RouteResponseArgs) ElementType ¶ added in v2.1.0
func (RouteResponseArgs) ElementType() reflect.Type
type RouteResponseState ¶ added in v2.1.0
type RouteResponseState struct { // The API identifier. ApiId pulumi.StringPtrInput // The [model selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) for the route response. ModelSelectionExpression pulumi.StringPtrInput // The response models for the route response. ResponseModels pulumi.StringMapInput // The identifier of the [`apigatewayv2.Route`](https://www.terraform.io/docs/providers/aws/r/apigatewayv2_route.html). RouteId pulumi.StringPtrInput // The route response key. RouteResponseKey pulumi.StringPtrInput }
func (RouteResponseState) ElementType ¶ added in v2.1.0
func (RouteResponseState) ElementType() reflect.Type
type RouteState ¶ added in v2.1.0
type RouteState struct { // The API identifier. ApiId pulumi.StringPtrInput // Boolean whether an API key is required for the route. Defaults to `false`. ApiKeyRequired pulumi.BoolPtrInput // The authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation. AuthorizationScopes pulumi.StringArrayInput // The authorization type for the route. // For WebSocket APIs, valid values are `NONE` for open access, `AWS_IAM` for using AWS IAM permissions, and `CUSTOM` for using a Lambda authorizer. // For HTTP APIs, valid values are `NONE` for open access, or `JWT` for using JSON Web Tokens. // Defaults to `NONE`. AuthorizationType pulumi.StringPtrInput // The identifier of the [`apigatewayv2.Authorizer`](https://www.terraform.io/docs/providers/aws/r/apigatewayv2_authorizer.html) resource to be associated with this route, if the authorizationType is `CUSTOM`. AuthorizerId pulumi.StringPtrInput // The [model selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) for the route. ModelSelectionExpression pulumi.StringPtrInput // The operation name for the route. OperationName pulumi.StringPtrInput // The request models for the route. RequestModels pulumi.StringMapInput // The route key for the route. RouteKey pulumi.StringPtrInput // The [route response selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-route-response-selection-expressions) for the route. RouteResponseSelectionExpression pulumi.StringPtrInput // The target for the route. Target pulumi.StringPtrInput }
func (RouteState) ElementType ¶ added in v2.1.0
func (RouteState) ElementType() reflect.Type
type Stage ¶ added in v2.1.0
type Stage struct { pulumi.CustomResourceState // Settings for logging access in this stage. // Use the [`apigateway.Account`](https://www.terraform.io/docs/providers/aws/r/api_gateway_account.html) resource to configure [permissions for CloudWatch Logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#set-up-access-logging-permissions). AccessLogSettings StageAccessLogSettingsPtrOutput `pulumi:"accessLogSettings"` // The API identifier. ApiId pulumi.StringOutput `pulumi:"apiId"` // The ARN of the stage. Arn pulumi.StringOutput `pulumi:"arn"` // Whether updates to an API automatically trigger a new deployment. Defaults to `false`. AutoDeploy pulumi.BoolPtrOutput `pulumi:"autoDeploy"` // The identifier of a client certificate for the stage. Use the [`apigateway.ClientCertificate`](https://www.terraform.io/docs/providers/aws/r/api_gateway_client_certificate.html) resource to configure a client certificate. // Supported only for WebSocket APIs. ClientCertificateId pulumi.StringPtrOutput `pulumi:"clientCertificateId"` // The default route settings for the stage. DefaultRouteSettings StageDefaultRouteSettingsPtrOutput `pulumi:"defaultRouteSettings"` // The deployment identifier of the stage. Use the `apigatewayv2.Deployment` resource to configure a deployment. DeploymentId pulumi.StringPtrOutput `pulumi:"deploymentId"` // The description for the stage. Description pulumi.StringPtrOutput `pulumi:"description"` // The ARN prefix to be used in an [`lambda.Permission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn` attribute // or in an [`iam.Policy`](https://www.terraform.io/docs/providers/aws/r/iam_policy.html) to authorize access to the [`@connections` API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html). // See the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-control-access-iam.html) for details. ExecutionArn pulumi.StringOutput `pulumi:"executionArn"` // The URL to invoke the API pointing to the stage, // e.g. `wss://z4675bid1j.execute-api.eu-west-2.amazonaws.com/example-stage` InvokeUrl pulumi.StringOutput `pulumi:"invokeUrl"` // The name of the stage. Name pulumi.StringOutput `pulumi:"name"` // Route settings for the stage. RouteSettings StageRouteSettingArrayOutput `pulumi:"routeSettings"` // A map that defines the stage variables for the stage. StageVariables pulumi.StringMapOutput `pulumi:"stageVariables"` // A mapping of tags to assign to the stage. Tags pulumi.MapOutput `pulumi:"tags"` }
Manages an Amazon API Gateway Version 2 stage. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html).
func GetStage ¶ added in v2.1.0
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).
type StageAccessLogSettings ¶ added in v2.1.0
type StageAccessLogSettings struct { // The ARN of the CloudWatch Logs log group to receive access logs. Any trailing `:*` is trimmed from the ARN. DestinationArn string `pulumi:"destinationArn"` // A single line [format](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#apigateway-cloudwatch-log-formats) of the access logs of data, as specified by [selected $context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.html). Format string `pulumi:"format"` }
type StageAccessLogSettingsArgs ¶ added in v2.1.0
type StageAccessLogSettingsArgs struct { // The ARN of the CloudWatch Logs log group to receive access logs. Any trailing `:*` is trimmed from the ARN. DestinationArn pulumi.StringInput `pulumi:"destinationArn"` // A single line [format](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#apigateway-cloudwatch-log-formats) of the access logs of data, as specified by [selected $context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.html). Format pulumi.StringInput `pulumi:"format"` }
func (StageAccessLogSettingsArgs) ElementType ¶ added in v2.1.0
func (StageAccessLogSettingsArgs) ElementType() reflect.Type
func (StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutput ¶ added in v2.1.0
func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutput() StageAccessLogSettingsOutput
func (StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutputWithContext ¶ added in v2.1.0
func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsOutputWithContext(ctx context.Context) StageAccessLogSettingsOutput
func (StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutput ¶ added in v2.1.0
func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput
func (StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutputWithContext ¶ added in v2.1.0
func (i StageAccessLogSettingsArgs) ToStageAccessLogSettingsPtrOutputWithContext(ctx context.Context) StageAccessLogSettingsPtrOutput
type StageAccessLogSettingsInput ¶ added in v2.1.0
type StageAccessLogSettingsInput interface { pulumi.Input ToStageAccessLogSettingsOutput() StageAccessLogSettingsOutput ToStageAccessLogSettingsOutputWithContext(context.Context) StageAccessLogSettingsOutput }
StageAccessLogSettingsInput is an input type that accepts StageAccessLogSettingsArgs and StageAccessLogSettingsOutput values. You can construct a concrete instance of `StageAccessLogSettingsInput` via:
StageAccessLogSettingsArgs{...}
type StageAccessLogSettingsOutput ¶ added in v2.1.0
type StageAccessLogSettingsOutput struct{ *pulumi.OutputState }
func (StageAccessLogSettingsOutput) DestinationArn ¶ added in v2.1.0
func (o StageAccessLogSettingsOutput) DestinationArn() pulumi.StringOutput
The ARN of the CloudWatch Logs log group to receive access logs. Any trailing `:*` is trimmed from the ARN.
func (StageAccessLogSettingsOutput) ElementType ¶ added in v2.1.0
func (StageAccessLogSettingsOutput) ElementType() reflect.Type
func (StageAccessLogSettingsOutput) Format ¶ added in v2.1.0
func (o StageAccessLogSettingsOutput) Format() pulumi.StringOutput
A single line [format](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#apigateway-cloudwatch-log-formats) of the access logs of data, as specified by [selected $context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.html).
func (StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutput ¶ added in v2.1.0
func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutput() StageAccessLogSettingsOutput
func (StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutputWithContext ¶ added in v2.1.0
func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsOutputWithContext(ctx context.Context) StageAccessLogSettingsOutput
func (StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutput ¶ added in v2.1.0
func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput
func (StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutputWithContext ¶ added in v2.1.0
func (o StageAccessLogSettingsOutput) ToStageAccessLogSettingsPtrOutputWithContext(ctx context.Context) StageAccessLogSettingsPtrOutput
type StageAccessLogSettingsPtrInput ¶ added in v2.1.0
type StageAccessLogSettingsPtrInput interface { pulumi.Input ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput ToStageAccessLogSettingsPtrOutputWithContext(context.Context) StageAccessLogSettingsPtrOutput }
StageAccessLogSettingsPtrInput is an input type that accepts StageAccessLogSettingsArgs, StageAccessLogSettingsPtr and StageAccessLogSettingsPtrOutput values. You can construct a concrete instance of `StageAccessLogSettingsPtrInput` via:
StageAccessLogSettingsArgs{...} or: nil
func StageAccessLogSettingsPtr ¶ added in v2.1.0
func StageAccessLogSettingsPtr(v *StageAccessLogSettingsArgs) StageAccessLogSettingsPtrInput
type StageAccessLogSettingsPtrOutput ¶ added in v2.1.0
type StageAccessLogSettingsPtrOutput struct{ *pulumi.OutputState }
func (StageAccessLogSettingsPtrOutput) DestinationArn ¶ added in v2.1.0
func (o StageAccessLogSettingsPtrOutput) DestinationArn() pulumi.StringPtrOutput
The ARN of the CloudWatch Logs log group to receive access logs. Any trailing `:*` is trimmed from the ARN.
func (StageAccessLogSettingsPtrOutput) Elem ¶ added in v2.1.0
func (o StageAccessLogSettingsPtrOutput) Elem() StageAccessLogSettingsOutput
func (StageAccessLogSettingsPtrOutput) ElementType ¶ added in v2.1.0
func (StageAccessLogSettingsPtrOutput) ElementType() reflect.Type
func (StageAccessLogSettingsPtrOutput) Format ¶ added in v2.1.0
func (o StageAccessLogSettingsPtrOutput) Format() pulumi.StringPtrOutput
A single line [format](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#apigateway-cloudwatch-log-formats) of the access logs of data, as specified by [selected $context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.html).
func (StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutput ¶ added in v2.1.0
func (o StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutput() StageAccessLogSettingsPtrOutput
func (StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutputWithContext ¶ added in v2.1.0
func (o StageAccessLogSettingsPtrOutput) ToStageAccessLogSettingsPtrOutputWithContext(ctx context.Context) StageAccessLogSettingsPtrOutput
type StageArgs ¶ added in v2.1.0
type StageArgs struct { // Settings for logging access in this stage. // Use the [`apigateway.Account`](https://www.terraform.io/docs/providers/aws/r/api_gateway_account.html) resource to configure [permissions for CloudWatch Logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#set-up-access-logging-permissions). AccessLogSettings StageAccessLogSettingsPtrInput // The API identifier. ApiId pulumi.StringInput // Whether updates to an API automatically trigger a new deployment. Defaults to `false`. AutoDeploy pulumi.BoolPtrInput // The identifier of a client certificate for the stage. Use the [`apigateway.ClientCertificate`](https://www.terraform.io/docs/providers/aws/r/api_gateway_client_certificate.html) resource to configure a client certificate. // Supported only for WebSocket APIs. ClientCertificateId pulumi.StringPtrInput // The default route settings for the stage. DefaultRouteSettings StageDefaultRouteSettingsPtrInput // The deployment identifier of the stage. Use the `apigatewayv2.Deployment` resource to configure a deployment. DeploymentId pulumi.StringPtrInput // The description for the stage. Description pulumi.StringPtrInput // The name of the stage. Name pulumi.StringPtrInput // Route settings for the stage. RouteSettings StageRouteSettingArrayInput // A map that defines the stage variables for the stage. StageVariables pulumi.StringMapInput // A mapping of tags to assign to the stage. Tags pulumi.MapInput }
The set of arguments for constructing a Stage resource.
func (StageArgs) ElementType ¶ added in v2.1.0
type StageDefaultRouteSettings ¶ added in v2.1.0
type StageDefaultRouteSettings struct { // Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. // Defaults to `false`. Supported only for WebSocket APIs. DataTraceEnabled *bool `pulumi:"dataTraceEnabled"` // Whether detailed metrics are enabled for the default route. Defaults to `false`. DetailedMetricsEnabled *bool `pulumi:"detailedMetricsEnabled"` // The logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. // Valid values: `ERROR`, `INFO`, `OFF`. Defaults to `OFF`. Supported only for WebSocket APIs. LoggingLevel *string `pulumi:"loggingLevel"` // The throttling burst limit for the default route. ThrottlingBurstLimit *int `pulumi:"throttlingBurstLimit"` // The throttling rate limit for the default route. ThrottlingRateLimit *float64 `pulumi:"throttlingRateLimit"` }
type StageDefaultRouteSettingsArgs ¶ added in v2.1.0
type StageDefaultRouteSettingsArgs struct { // Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. // Defaults to `false`. Supported only for WebSocket APIs. DataTraceEnabled pulumi.BoolPtrInput `pulumi:"dataTraceEnabled"` // Whether detailed metrics are enabled for the default route. Defaults to `false`. DetailedMetricsEnabled pulumi.BoolPtrInput `pulumi:"detailedMetricsEnabled"` // The logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. // Valid values: `ERROR`, `INFO`, `OFF`. Defaults to `OFF`. Supported only for WebSocket APIs. LoggingLevel pulumi.StringPtrInput `pulumi:"loggingLevel"` // The throttling burst limit for the default route. ThrottlingBurstLimit pulumi.IntPtrInput `pulumi:"throttlingBurstLimit"` // The throttling rate limit for the default route. ThrottlingRateLimit pulumi.Float64PtrInput `pulumi:"throttlingRateLimit"` }
func (StageDefaultRouteSettingsArgs) ElementType ¶ added in v2.1.0
func (StageDefaultRouteSettingsArgs) ElementType() reflect.Type
func (StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsOutput ¶ added in v2.1.0
func (i StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsOutput() StageDefaultRouteSettingsOutput
func (StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsOutputWithContext ¶ added in v2.1.0
func (i StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsOutputWithContext(ctx context.Context) StageDefaultRouteSettingsOutput
func (StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsPtrOutput ¶ added in v2.1.0
func (i StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsPtrOutput() StageDefaultRouteSettingsPtrOutput
func (StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsPtrOutputWithContext ¶ added in v2.1.0
func (i StageDefaultRouteSettingsArgs) ToStageDefaultRouteSettingsPtrOutputWithContext(ctx context.Context) StageDefaultRouteSettingsPtrOutput
type StageDefaultRouteSettingsInput ¶ added in v2.1.0
type StageDefaultRouteSettingsInput interface { pulumi.Input ToStageDefaultRouteSettingsOutput() StageDefaultRouteSettingsOutput ToStageDefaultRouteSettingsOutputWithContext(context.Context) StageDefaultRouteSettingsOutput }
StageDefaultRouteSettingsInput is an input type that accepts StageDefaultRouteSettingsArgs and StageDefaultRouteSettingsOutput values. You can construct a concrete instance of `StageDefaultRouteSettingsInput` via:
StageDefaultRouteSettingsArgs{...}
type StageDefaultRouteSettingsOutput ¶ added in v2.1.0
type StageDefaultRouteSettingsOutput struct{ *pulumi.OutputState }
func (StageDefaultRouteSettingsOutput) DataTraceEnabled ¶ added in v2.1.0
func (o StageDefaultRouteSettingsOutput) DataTraceEnabled() pulumi.BoolPtrOutput
Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to `false`. Supported only for WebSocket APIs.
func (StageDefaultRouteSettingsOutput) DetailedMetricsEnabled ¶ added in v2.1.0
func (o StageDefaultRouteSettingsOutput) DetailedMetricsEnabled() pulumi.BoolPtrOutput
Whether detailed metrics are enabled for the default route. Defaults to `false`.
func (StageDefaultRouteSettingsOutput) ElementType ¶ added in v2.1.0
func (StageDefaultRouteSettingsOutput) ElementType() reflect.Type
func (StageDefaultRouteSettingsOutput) LoggingLevel ¶ added in v2.1.0
func (o StageDefaultRouteSettingsOutput) LoggingLevel() pulumi.StringPtrOutput
The logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: `ERROR`, `INFO`, `OFF`. Defaults to `OFF`. Supported only for WebSocket APIs.
func (StageDefaultRouteSettingsOutput) ThrottlingBurstLimit ¶ added in v2.1.0
func (o StageDefaultRouteSettingsOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput
The throttling burst limit for the default route.
func (StageDefaultRouteSettingsOutput) ThrottlingRateLimit ¶ added in v2.1.0
func (o StageDefaultRouteSettingsOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput
The throttling rate limit for the default route.
func (StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsOutput ¶ added in v2.1.0
func (o StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsOutput() StageDefaultRouteSettingsOutput
func (StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsOutputWithContext ¶ added in v2.1.0
func (o StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsOutputWithContext(ctx context.Context) StageDefaultRouteSettingsOutput
func (StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsPtrOutput ¶ added in v2.1.0
func (o StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsPtrOutput() StageDefaultRouteSettingsPtrOutput
func (StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsPtrOutputWithContext ¶ added in v2.1.0
func (o StageDefaultRouteSettingsOutput) ToStageDefaultRouteSettingsPtrOutputWithContext(ctx context.Context) StageDefaultRouteSettingsPtrOutput
type StageDefaultRouteSettingsPtrInput ¶ added in v2.1.0
type StageDefaultRouteSettingsPtrInput interface { pulumi.Input ToStageDefaultRouteSettingsPtrOutput() StageDefaultRouteSettingsPtrOutput ToStageDefaultRouteSettingsPtrOutputWithContext(context.Context) StageDefaultRouteSettingsPtrOutput }
StageDefaultRouteSettingsPtrInput is an input type that accepts StageDefaultRouteSettingsArgs, StageDefaultRouteSettingsPtr and StageDefaultRouteSettingsPtrOutput values. You can construct a concrete instance of `StageDefaultRouteSettingsPtrInput` via:
StageDefaultRouteSettingsArgs{...} or: nil
func StageDefaultRouteSettingsPtr ¶ added in v2.1.0
func StageDefaultRouteSettingsPtr(v *StageDefaultRouteSettingsArgs) StageDefaultRouteSettingsPtrInput
type StageDefaultRouteSettingsPtrOutput ¶ added in v2.1.0
type StageDefaultRouteSettingsPtrOutput struct{ *pulumi.OutputState }
func (StageDefaultRouteSettingsPtrOutput) DataTraceEnabled ¶ added in v2.1.0
func (o StageDefaultRouteSettingsPtrOutput) DataTraceEnabled() pulumi.BoolPtrOutput
Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to `false`. Supported only for WebSocket APIs.
func (StageDefaultRouteSettingsPtrOutput) DetailedMetricsEnabled ¶ added in v2.1.0
func (o StageDefaultRouteSettingsPtrOutput) DetailedMetricsEnabled() pulumi.BoolPtrOutput
Whether detailed metrics are enabled for the default route. Defaults to `false`.
func (StageDefaultRouteSettingsPtrOutput) Elem ¶ added in v2.1.0
func (o StageDefaultRouteSettingsPtrOutput) Elem() StageDefaultRouteSettingsOutput
func (StageDefaultRouteSettingsPtrOutput) ElementType ¶ added in v2.1.0
func (StageDefaultRouteSettingsPtrOutput) ElementType() reflect.Type
func (StageDefaultRouteSettingsPtrOutput) LoggingLevel ¶ added in v2.1.0
func (o StageDefaultRouteSettingsPtrOutput) LoggingLevel() pulumi.StringPtrOutput
The logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: `ERROR`, `INFO`, `OFF`. Defaults to `OFF`. Supported only for WebSocket APIs.
func (StageDefaultRouteSettingsPtrOutput) ThrottlingBurstLimit ¶ added in v2.1.0
func (o StageDefaultRouteSettingsPtrOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput
The throttling burst limit for the default route.
func (StageDefaultRouteSettingsPtrOutput) ThrottlingRateLimit ¶ added in v2.1.0
func (o StageDefaultRouteSettingsPtrOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput
The throttling rate limit for the default route.
func (StageDefaultRouteSettingsPtrOutput) ToStageDefaultRouteSettingsPtrOutput ¶ added in v2.1.0
func (o StageDefaultRouteSettingsPtrOutput) ToStageDefaultRouteSettingsPtrOutput() StageDefaultRouteSettingsPtrOutput
func (StageDefaultRouteSettingsPtrOutput) ToStageDefaultRouteSettingsPtrOutputWithContext ¶ added in v2.1.0
func (o StageDefaultRouteSettingsPtrOutput) ToStageDefaultRouteSettingsPtrOutputWithContext(ctx context.Context) StageDefaultRouteSettingsPtrOutput
type StageRouteSetting ¶ added in v2.1.0
type StageRouteSetting struct { // Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs. // Defaults to `false`. Supported only for WebSocket APIs. DataTraceEnabled *bool `pulumi:"dataTraceEnabled"` // Whether detailed metrics are enabled for the route. Defaults to `false`. DetailedMetricsEnabled *bool `pulumi:"detailedMetricsEnabled"` // The logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs. // Valid values: `ERROR`, `INFO`, `OFF`. Defaults to `OFF`. Supported only for WebSocket APIs. LoggingLevel *string `pulumi:"loggingLevel"` // Route key. RouteKey string `pulumi:"routeKey"` // The throttling burst limit for the route. ThrottlingBurstLimit *int `pulumi:"throttlingBurstLimit"` // The throttling rate limit for the route. ThrottlingRateLimit *float64 `pulumi:"throttlingRateLimit"` }
type StageRouteSettingArgs ¶ added in v2.1.0
type StageRouteSettingArgs struct { // Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs. // Defaults to `false`. Supported only for WebSocket APIs. DataTraceEnabled pulumi.BoolPtrInput `pulumi:"dataTraceEnabled"` // Whether detailed metrics are enabled for the route. Defaults to `false`. DetailedMetricsEnabled pulumi.BoolPtrInput `pulumi:"detailedMetricsEnabled"` // The logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs. // Valid values: `ERROR`, `INFO`, `OFF`. Defaults to `OFF`. Supported only for WebSocket APIs. LoggingLevel pulumi.StringPtrInput `pulumi:"loggingLevel"` // Route key. RouteKey pulumi.StringInput `pulumi:"routeKey"` // The throttling burst limit for the route. ThrottlingBurstLimit pulumi.IntPtrInput `pulumi:"throttlingBurstLimit"` // The throttling rate limit for the route. ThrottlingRateLimit pulumi.Float64PtrInput `pulumi:"throttlingRateLimit"` }
func (StageRouteSettingArgs) ElementType ¶ added in v2.1.0
func (StageRouteSettingArgs) ElementType() reflect.Type
func (StageRouteSettingArgs) ToStageRouteSettingOutput ¶ added in v2.1.0
func (i StageRouteSettingArgs) ToStageRouteSettingOutput() StageRouteSettingOutput
func (StageRouteSettingArgs) ToStageRouteSettingOutputWithContext ¶ added in v2.1.0
func (i StageRouteSettingArgs) ToStageRouteSettingOutputWithContext(ctx context.Context) StageRouteSettingOutput
type StageRouteSettingArray ¶ added in v2.1.0
type StageRouteSettingArray []StageRouteSettingInput
func (StageRouteSettingArray) ElementType ¶ added in v2.1.0
func (StageRouteSettingArray) ElementType() reflect.Type
func (StageRouteSettingArray) ToStageRouteSettingArrayOutput ¶ added in v2.1.0
func (i StageRouteSettingArray) ToStageRouteSettingArrayOutput() StageRouteSettingArrayOutput
func (StageRouteSettingArray) ToStageRouteSettingArrayOutputWithContext ¶ added in v2.1.0
func (i StageRouteSettingArray) ToStageRouteSettingArrayOutputWithContext(ctx context.Context) StageRouteSettingArrayOutput
type StageRouteSettingArrayInput ¶ added in v2.1.0
type StageRouteSettingArrayInput interface { pulumi.Input ToStageRouteSettingArrayOutput() StageRouteSettingArrayOutput ToStageRouteSettingArrayOutputWithContext(context.Context) StageRouteSettingArrayOutput }
StageRouteSettingArrayInput is an input type that accepts StageRouteSettingArray and StageRouteSettingArrayOutput values. You can construct a concrete instance of `StageRouteSettingArrayInput` via:
StageRouteSettingArray{ StageRouteSettingArgs{...} }
type StageRouteSettingArrayOutput ¶ added in v2.1.0
type StageRouteSettingArrayOutput struct{ *pulumi.OutputState }
func (StageRouteSettingArrayOutput) ElementType ¶ added in v2.1.0
func (StageRouteSettingArrayOutput) ElementType() reflect.Type
func (StageRouteSettingArrayOutput) Index ¶ added in v2.1.0
func (o StageRouteSettingArrayOutput) Index(i pulumi.IntInput) StageRouteSettingOutput
func (StageRouteSettingArrayOutput) ToStageRouteSettingArrayOutput ¶ added in v2.1.0
func (o StageRouteSettingArrayOutput) ToStageRouteSettingArrayOutput() StageRouteSettingArrayOutput
func (StageRouteSettingArrayOutput) ToStageRouteSettingArrayOutputWithContext ¶ added in v2.1.0
func (o StageRouteSettingArrayOutput) ToStageRouteSettingArrayOutputWithContext(ctx context.Context) StageRouteSettingArrayOutput
type StageRouteSettingInput ¶ added in v2.1.0
type StageRouteSettingInput interface { pulumi.Input ToStageRouteSettingOutput() StageRouteSettingOutput ToStageRouteSettingOutputWithContext(context.Context) StageRouteSettingOutput }
StageRouteSettingInput is an input type that accepts StageRouteSettingArgs and StageRouteSettingOutput values. You can construct a concrete instance of `StageRouteSettingInput` via:
StageRouteSettingArgs{...}
type StageRouteSettingOutput ¶ added in v2.1.0
type StageRouteSettingOutput struct{ *pulumi.OutputState }
func (StageRouteSettingOutput) DataTraceEnabled ¶ added in v2.1.0
func (o StageRouteSettingOutput) DataTraceEnabled() pulumi.BoolPtrOutput
Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to `false`. Supported only for WebSocket APIs.
func (StageRouteSettingOutput) DetailedMetricsEnabled ¶ added in v2.1.0
func (o StageRouteSettingOutput) DetailedMetricsEnabled() pulumi.BoolPtrOutput
Whether detailed metrics are enabled for the route. Defaults to `false`.
func (StageRouteSettingOutput) ElementType ¶ added in v2.1.0
func (StageRouteSettingOutput) ElementType() reflect.Type
func (StageRouteSettingOutput) LoggingLevel ¶ added in v2.1.0
func (o StageRouteSettingOutput) LoggingLevel() pulumi.StringPtrOutput
The logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: `ERROR`, `INFO`, `OFF`. Defaults to `OFF`. Supported only for WebSocket APIs.
func (StageRouteSettingOutput) RouteKey ¶ added in v2.1.0
func (o StageRouteSettingOutput) RouteKey() pulumi.StringOutput
Route key.
func (StageRouteSettingOutput) ThrottlingBurstLimit ¶ added in v2.1.0
func (o StageRouteSettingOutput) ThrottlingBurstLimit() pulumi.IntPtrOutput
The throttling burst limit for the route.
func (StageRouteSettingOutput) ThrottlingRateLimit ¶ added in v2.1.0
func (o StageRouteSettingOutput) ThrottlingRateLimit() pulumi.Float64PtrOutput
The throttling rate limit for the route.
func (StageRouteSettingOutput) ToStageRouteSettingOutput ¶ added in v2.1.0
func (o StageRouteSettingOutput) ToStageRouteSettingOutput() StageRouteSettingOutput
func (StageRouteSettingOutput) ToStageRouteSettingOutputWithContext ¶ added in v2.1.0
func (o StageRouteSettingOutput) ToStageRouteSettingOutputWithContext(ctx context.Context) StageRouteSettingOutput
type StageState ¶ added in v2.1.0
type StageState struct { // Settings for logging access in this stage. // Use the [`apigateway.Account`](https://www.terraform.io/docs/providers/aws/r/api_gateway_account.html) resource to configure [permissions for CloudWatch Logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#set-up-access-logging-permissions). AccessLogSettings StageAccessLogSettingsPtrInput // The API identifier. ApiId pulumi.StringPtrInput // The ARN of the stage. Arn pulumi.StringPtrInput // Whether updates to an API automatically trigger a new deployment. Defaults to `false`. AutoDeploy pulumi.BoolPtrInput // The identifier of a client certificate for the stage. Use the [`apigateway.ClientCertificate`](https://www.terraform.io/docs/providers/aws/r/api_gateway_client_certificate.html) resource to configure a client certificate. // Supported only for WebSocket APIs. ClientCertificateId pulumi.StringPtrInput // The default route settings for the stage. DefaultRouteSettings StageDefaultRouteSettingsPtrInput // The deployment identifier of the stage. Use the `apigatewayv2.Deployment` resource to configure a deployment. DeploymentId pulumi.StringPtrInput // The description for the stage. Description pulumi.StringPtrInput // The ARN prefix to be used in an [`lambda.Permission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `sourceArn` attribute // or in an [`iam.Policy`](https://www.terraform.io/docs/providers/aws/r/iam_policy.html) to authorize access to the [`@connections` API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html). // See the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-control-access-iam.html) for details. ExecutionArn pulumi.StringPtrInput // The URL to invoke the API pointing to the stage, // e.g. `wss://z4675bid1j.execute-api.eu-west-2.amazonaws.com/example-stage` InvokeUrl pulumi.StringPtrInput // The name of the stage. Name pulumi.StringPtrInput // Route settings for the stage. RouteSettings StageRouteSettingArrayInput // A map that defines the stage variables for the stage. StageVariables pulumi.StringMapInput // A mapping of tags to assign to the stage. Tags pulumi.MapInput }
func (StageState) ElementType ¶ added in v2.1.0
func (StageState) ElementType() reflect.Type