apigateway

package
v0.16.0 Latest Latest
Warning

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

Go to latest
Published: Oct 12, 2018 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {
	// contains filtered or unexported fields
}

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

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

func GetAccount

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

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

func NewAccount

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

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

func (*Account) CloudwatchRoleArn

func (r *Account) CloudwatchRoleArn() *pulumi.StringOutput

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

func (*Account) ID

func (r *Account) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Account) ThrottleSettings

func (r *Account) ThrottleSettings() *pulumi.Output

Account-Level throttle settings. See exported fields below.

func (*Account) URN

func (r *Account) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type AccountArgs

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

The set of arguments for constructing a Account resource.

type AccountState

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

Input properties used for looking up and filtering Account resources.

type ApiKey

type ApiKey struct {
	// contains filtered or unexported fields
}

Provides an API Gateway API Key.

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

func GetApiKey

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

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

func NewApiKey

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

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

func (*ApiKey) CreatedDate

func (r *ApiKey) CreatedDate() *pulumi.StringOutput

The creation date of the API key

func (*ApiKey) Description

func (r *ApiKey) Description() *pulumi.StringOutput

The API key description. Defaults to "Managed by Terraform".

func (*ApiKey) Enabled

func (r *ApiKey) Enabled() *pulumi.BoolOutput

Specifies whether the API key can be used by callers. Defaults to `true`.

func (*ApiKey) ID

func (r *ApiKey) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ApiKey) LastUpdatedDate

func (r *ApiKey) LastUpdatedDate() *pulumi.StringOutput

The last update date of the API key

func (*ApiKey) Name

func (r *ApiKey) Name() *pulumi.StringOutput

The name of the API key

func (*ApiKey) StageKeys

func (r *ApiKey) StageKeys() *pulumi.ArrayOutput

A list of stage keys associated with the API key - see below

func (*ApiKey) URN

func (r *ApiKey) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*ApiKey) Value

func (r *ApiKey) Value() *pulumi.StringOutput

The value of the API key. If not specified, it will be automatically generated by AWS on creation.

type ApiKeyArgs

type ApiKeyArgs struct {
	// The API key description. Defaults to "Managed by Terraform".
	Description interface{}
	// Specifies whether the API key can be used by callers. Defaults to `true`.
	Enabled interface{}
	// The name of the API key
	Name interface{}
	// A list of stage keys associated with the API key - see below
	StageKeys interface{}
	// The value of the API key. If not specified, it will be automatically generated by AWS on creation.
	Value interface{}
}

The set of arguments for constructing a ApiKey resource.

type ApiKeyState

type ApiKeyState struct {
	// The creation date of the API key
	CreatedDate interface{}
	// The API key description. Defaults to "Managed by Terraform".
	Description interface{}
	// Specifies whether the API key can be used by callers. Defaults to `true`.
	Enabled interface{}
	// The last update date of the API key
	LastUpdatedDate interface{}
	// The name of the API key
	Name interface{}
	// A list of stage keys associated with the API key - see below
	StageKeys interface{}
	// The value of the API key. If not specified, it will be automatically generated by AWS on creation.
	Value interface{}
}

Input properties used for looking up and filtering ApiKey resources.

type Authorizer

type Authorizer struct {
	// contains filtered or unexported fields
}

Provides an API Gateway Authorizer.

func GetAuthorizer

func GetAuthorizer(ctx *pulumi.Context,
	name string, id pulumi.ID, state *AuthorizerState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*Authorizer, error)

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

func (*Authorizer) AuthorizerCredentials

func (r *Authorizer) AuthorizerCredentials() *pulumi.StringOutput

The credentials required for the authorizer. To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.

func (*Authorizer) AuthorizerResultTtlInSeconds

func (r *Authorizer) AuthorizerResultTtlInSeconds() *pulumi.IntOutput

The TTL of cached authorizer results in seconds. Defaults to `300`.

func (*Authorizer) AuthorizerUri

func (r *Authorizer) AuthorizerUri() *pulumi.StringOutput

The authorizer's Uniform Resource Identifier (URI). This must be a well-formed Lambda function URI in the form of `arn:aws:apigateway:{region}:lambda:path/{service_api}`, e.g. `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations`

func (*Authorizer) ID

func (r *Authorizer) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Authorizer) IdentitySource

func (r *Authorizer) IdentitySource() *pulumi.StringOutput

The source of the identity in an incoming request. Defaults to `method.request.header.Authorization`. For `REQUEST` type, this may be a comma-separated list of values, including headers, query string parameters and stage variables - e.g. `"method.request.header.SomeHeaderName,method.request.querystring.SomeQueryStringName,stageVariables.SomeStageVariableName"`

func (*Authorizer) IdentityValidationExpression

func (r *Authorizer) IdentityValidationExpression() *pulumi.StringOutput

A validation expression for the incoming identity. For `TOKEN` type, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

func (*Authorizer) Name

func (r *Authorizer) Name() *pulumi.StringOutput

The name of the authorizer

func (*Authorizer) ProviderArns

func (r *Authorizer) ProviderArns() *pulumi.ArrayOutput

A list of the Amazon Cognito user pool ARNs. Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`.

func (*Authorizer) RestApi

func (r *Authorizer) RestApi() *pulumi.StringOutput

The ID of the associated REST API

func (*Authorizer) Type

func (r *Authorizer) Type() *pulumi.StringOutput

The type of the authorizer. Possible values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, or `COGNITO_USER_POOLS` for using an Amazon Cognito user pool. Defaults to `TOKEN`.

func (*Authorizer) URN

func (r *Authorizer) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type AuthorizerArgs

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

The set of arguments for constructing a Authorizer resource.

type AuthorizerState

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

Input properties used for looking up and filtering Authorizer resources.

type BasePathMapping

type BasePathMapping struct {
	// contains filtered or unexported fields
}

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

func GetBasePathMapping

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

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

func NewBasePathMapping

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

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

func (*BasePathMapping) BasePath

func (r *BasePathMapping) BasePath() *pulumi.StringOutput

Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.

func (*BasePathMapping) DomainName

func (r *BasePathMapping) DomainName() *pulumi.StringOutput

The already-registered domain name to connect the API to.

func (*BasePathMapping) ID

func (r *BasePathMapping) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*BasePathMapping) RestApi

func (r *BasePathMapping) RestApi() *pulumi.StringOutput

The id of the API to connect.

func (*BasePathMapping) StageName

func (r *BasePathMapping) StageName() *pulumi.StringOutput

The name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

func (*BasePathMapping) URN

func (r *BasePathMapping) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type BasePathMappingArgs

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

The set of arguments for constructing a BasePathMapping resource.

type BasePathMappingState

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

Input properties used for looking up and filtering BasePathMapping resources.

type ClientCertificate

type ClientCertificate struct {
	// contains filtered or unexported fields
}

Provides an API Gateway Client Certificate.

func GetClientCertificate

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

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

func NewClientCertificate

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

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

func (*ClientCertificate) CreatedDate

func (r *ClientCertificate) CreatedDate() *pulumi.StringOutput

The date when the client certificate was created.

func (*ClientCertificate) Description

func (r *ClientCertificate) Description() *pulumi.StringOutput

The description of the client certificate.

func (*ClientCertificate) ExpirationDate

func (r *ClientCertificate) ExpirationDate() *pulumi.StringOutput

The date when the client certificate will expire.

func (*ClientCertificate) ID

ID is this resource's unique identifier assigned by its provider.

func (*ClientCertificate) PemEncodedCertificate

func (r *ClientCertificate) PemEncodedCertificate() *pulumi.StringOutput

The PEM-encoded public key of the client certificate.

func (*ClientCertificate) URN

URN is this resource's unique name assigned by Pulumi.

type ClientCertificateArgs

type ClientCertificateArgs struct {
	// The description of the client certificate.
	Description interface{}
}

The set of arguments for constructing a ClientCertificate resource.

type ClientCertificateState

type ClientCertificateState struct {
	// The date when the client certificate was created.
	CreatedDate interface{}
	// The description of the client certificate.
	Description interface{}
	// The date when the client certificate will expire.
	ExpirationDate interface{}
	// The PEM-encoded public key of the client certificate.
	PemEncodedCertificate interface{}
}

Input properties used for looking up and filtering ClientCertificate resources.

type Deployment

type Deployment struct {
	// contains filtered or unexported fields
}

Provides an API Gateway Deployment.

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

func GetDeployment

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

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

func NewDeployment

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

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

func (*Deployment) CreatedDate

func (r *Deployment) CreatedDate() *pulumi.StringOutput

The creation date of the deployment

func (*Deployment) Description

func (r *Deployment) Description() *pulumi.StringOutput

The description of the deployment

func (*Deployment) ExecutionArn

func (r *Deployment) ExecutionArn() *pulumi.StringOutput

The execution ARN to be used in [`lambda_permission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `source_arn` when allowing API Gateway to invoke a Lambda function, e.g. `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod`

func (*Deployment) ID

func (r *Deployment) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Deployment) InvokeUrl

func (r *Deployment) InvokeUrl() *pulumi.StringOutput

The URL to invoke the API pointing to the stage, e.g. `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod`

func (*Deployment) RestApi

func (r *Deployment) RestApi() *pulumi.StringOutput

The ID of the associated REST API

func (*Deployment) StageDescription

func (r *Deployment) StageDescription() *pulumi.StringOutput

The description of the stage

func (*Deployment) StageName

func (r *Deployment) StageName() *pulumi.StringOutput

The name of the stage. If the specified stage already exists, it will be updated to point to the new deployment. If the stage does not exist, a new one will be created and point to this deployment. Use `""` to point at the default stage.

func (*Deployment) URN

func (r *Deployment) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Deployment) Variables

func (r *Deployment) Variables() *pulumi.MapOutput

A map that defines variables for the stage

type DeploymentArgs

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

The set of arguments for constructing a Deployment resource.

type DeploymentState

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

Input properties used for looking up and filtering Deployment resources.

type DocumentationPart

type DocumentationPart struct {
	// contains filtered or unexported fields
}

Provides a settings of an API Gateway Documentation Part.

func GetDocumentationPart

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

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

func NewDocumentationPart

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

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

func (*DocumentationPart) ID

ID is this resource's unique identifier assigned by its provider.

func (*DocumentationPart) Location

func (r *DocumentationPart) Location() *pulumi.Output

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

func (*DocumentationPart) Properties

func (r *DocumentationPart) Properties() *pulumi.StringOutput

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant key-value pairs can be exported and, hence, published.

func (*DocumentationPart) RestApiId

func (r *DocumentationPart) RestApiId() *pulumi.StringOutput

The ID of the associated Rest API

func (*DocumentationPart) URN

URN is this resource's unique name assigned by Pulumi.

type DocumentationPartArgs

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

The set of arguments for constructing a DocumentationPart resource.

type DocumentationPartState

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

Input properties used for looking up and filtering DocumentationPart resources.

type DocumentationVersion

type DocumentationVersion struct {
	// contains filtered or unexported fields
}

Provides a resource to manage an API Gateway Documentation Version.

func GetDocumentationVersion

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

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

func NewDocumentationVersion

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

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

func (*DocumentationVersion) Description

func (r *DocumentationVersion) Description() *pulumi.StringOutput

The description of the API documentation version.

func (*DocumentationVersion) ID

ID is this resource's unique identifier assigned by its provider.

func (*DocumentationVersion) RestApiId

func (r *DocumentationVersion) RestApiId() *pulumi.StringOutput

The ID of the associated Rest API

func (*DocumentationVersion) URN

URN is this resource's unique name assigned by Pulumi.

func (*DocumentationVersion) Version

The version identifier of the API documentation snapshot.

type DocumentationVersionArgs

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

The set of arguments for constructing a DocumentationVersion resource.

type DocumentationVersionState

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

Input properties used for looking up and filtering DocumentationVersion resources.

type DomainName

type DomainName struct {
	// contains filtered or unexported fields
}

Registers a custom domain name for use with AWS API Gateway.

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

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

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

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

func GetDomainName

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

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

func NewDomainName

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

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

func (*DomainName) CertificateArn

func (r *DomainName) CertificateArn() *pulumi.StringOutput

The ARN for an AWS-managed certificate. Used when an edge-optimized domain name is desired. Conflicts with `certificate_name`, `certificate_body`, `certificate_chain`, `certificate_private_key`, `regional_certificate_arn`, and `regional_certificate_name`.

func (*DomainName) CertificateBody

func (r *DomainName) CertificateBody() *pulumi.StringOutput

The certificate issued for the domain name being registered, in PEM format. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificate_arn`, `regional_certificate_arn`, and `regional_certificate_name`.

func (*DomainName) CertificateChain

func (r *DomainName) CertificateChain() *pulumi.StringOutput

The certificate for the CA that issued the certificate, along with any intermediate CA certificates required to create an unbroken chain to a certificate trusted by the intended API clients. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificate_arn`, `regional_certificate_arn`, and `regional_certificate_name`.

func (*DomainName) CertificateName

func (r *DomainName) CertificateName() *pulumi.StringOutput

The unique name to use when registering this certificate as an IAM server certificate. Conflicts with `certificate_arn`, `regional_certificate_arn`, and `regional_certificate_name`. Required if `certificate_arn` is not set.

func (*DomainName) CertificatePrivateKey

func (r *DomainName) CertificatePrivateKey() *pulumi.StringOutput

The private key associated with the domain certificate given in `certificate_body`. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificate_arn`, `regional_certificate_arn`, and `regional_certificate_name`.

func (*DomainName) CertificateUploadDate

func (r *DomainName) CertificateUploadDate() *pulumi.StringOutput

The upload date associated with the domain certificate.

func (*DomainName) CloudfrontDomainName

func (r *DomainName) CloudfrontDomainName() *pulumi.StringOutput

The hostname created by Cloudfront to represent the distribution that implements this domain name mapping.

func (*DomainName) CloudfrontZoneId

func (r *DomainName) CloudfrontZoneId() *pulumi.StringOutput

For convenience, the hosted zone ID (`Z2FDTNDATAQYW2`) that can be used to create a Route53 alias record for the distribution.

func (*DomainName) DomainName

func (r *DomainName) DomainName() *pulumi.StringOutput

The fully-qualified domain name to register

func (*DomainName) EndpointConfiguration

func (r *DomainName) EndpointConfiguration() *pulumi.Output

Nested argument defining API endpoint configuration including endpoint type. Defined below.

func (*DomainName) ID

func (r *DomainName) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*DomainName) RegionalCertificateArn

func (r *DomainName) RegionalCertificateArn() *pulumi.StringOutput

The ARN for an AWS-managed certificate. Used when a regional domain name is desired. Conflicts with `certificate_arn`, `certificate_name`, `certificate_body`, `certificate_chain`, and `certificate_private_key`.

func (*DomainName) RegionalCertificateName

func (r *DomainName) RegionalCertificateName() *pulumi.StringOutput

The user-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts with `certificate_arn`, `certificate_name`, `certificate_body`, `certificate_chain`, and `certificate_private_key`.

func (*DomainName) RegionalDomainName

func (r *DomainName) RegionalDomainName() *pulumi.StringOutput

The hostname for the custom domain's regional endpoint.

func (*DomainName) RegionalZoneId

func (r *DomainName) RegionalZoneId() *pulumi.StringOutput

The hosted zone ID that can be used to create a Route53 alias record for the regional endpoint.

func (*DomainName) URN

func (r *DomainName) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type DomainNameArgs

type DomainNameArgs struct {
	// The ARN for an AWS-managed certificate. Used when an edge-optimized domain name is
	// desired. Conflicts with `certificate_name`, `certificate_body`, `certificate_chain`, `certificate_private_key`,
	// `regional_certificate_arn`, and `regional_certificate_name`.
	CertificateArn interface{}
	// The certificate issued for the domain name
	// being registered, in PEM format. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificate_arn`, `regional_certificate_arn`, and
	// `regional_certificate_name`.
	CertificateBody interface{}
	// The certificate for the CA that issued the
	// certificate, along with any intermediate CA certificates required to
	// create an unbroken chain to a certificate trusted by the intended API clients. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificate_arn`,
	// `regional_certificate_arn`, and `regional_certificate_name`.
	CertificateChain interface{}
	// The unique name to use when registering this
	// certificate as an IAM server certificate. Conflicts with `certificate_arn`, `regional_certificate_arn`, and
	// `regional_certificate_name`. Required if `certificate_arn` is not set.
	CertificateName interface{}
	// The private key associated with the
	// domain certificate given in `certificate_body`. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificate_arn`, `regional_certificate_arn`, and `regional_certificate_name`.
	CertificatePrivateKey interface{}
	// The fully-qualified domain name to register
	DomainName interface{}
	// Nested argument defining API endpoint configuration including endpoint type. Defined below.
	EndpointConfiguration interface{}
	// The ARN for an AWS-managed certificate. Used when a regional domain name is
	// desired. Conflicts with `certificate_arn`, `certificate_name`, `certificate_body`, `certificate_chain`, and
	// `certificate_private_key`.
	RegionalCertificateArn interface{}
	// The user-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts with `certificate_arn`, `certificate_name`, `certificate_body`, `certificate_chain`, and
	// `certificate_private_key`.
	RegionalCertificateName interface{}
}

The set of arguments for constructing a DomainName resource.

type DomainNameState

type DomainNameState struct {
	// The ARN for an AWS-managed certificate. Used when an edge-optimized domain name is
	// desired. Conflicts with `certificate_name`, `certificate_body`, `certificate_chain`, `certificate_private_key`,
	// `regional_certificate_arn`, and `regional_certificate_name`.
	CertificateArn interface{}
	// The certificate issued for the domain name
	// being registered, in PEM format. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificate_arn`, `regional_certificate_arn`, and
	// `regional_certificate_name`.
	CertificateBody interface{}
	// The certificate for the CA that issued the
	// certificate, along with any intermediate CA certificates required to
	// create an unbroken chain to a certificate trusted by the intended API clients. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificate_arn`,
	// `regional_certificate_arn`, and `regional_certificate_name`.
	CertificateChain interface{}
	// The unique name to use when registering this
	// certificate as an IAM server certificate. Conflicts with `certificate_arn`, `regional_certificate_arn`, and
	// `regional_certificate_name`. Required if `certificate_arn` is not set.
	CertificateName interface{}
	// The private key associated with the
	// domain certificate given in `certificate_body`. Only valid for `EDGE` endpoint configuration type. Conflicts with `certificate_arn`, `regional_certificate_arn`, and `regional_certificate_name`.
	CertificatePrivateKey interface{}
	// The upload date associated with the domain certificate.
	CertificateUploadDate interface{}
	// The hostname created by Cloudfront to represent
	// the distribution that implements this domain name mapping.
	CloudfrontDomainName interface{}
	// For convenience, the hosted zone ID (`Z2FDTNDATAQYW2`)
	// that can be used to create a Route53 alias record for the distribution.
	CloudfrontZoneId interface{}
	// The fully-qualified domain name to register
	DomainName interface{}
	// Nested argument defining API endpoint configuration including endpoint type. Defined below.
	EndpointConfiguration interface{}
	// The ARN for an AWS-managed certificate. Used when a regional domain name is
	// desired. Conflicts with `certificate_arn`, `certificate_name`, `certificate_body`, `certificate_chain`, and
	// `certificate_private_key`.
	RegionalCertificateArn interface{}
	// The user-friendly name of the certificate that will be used by regional endpoint for this domain name. Conflicts with `certificate_arn`, `certificate_name`, `certificate_body`, `certificate_chain`, and
	// `certificate_private_key`.
	RegionalCertificateName interface{}
	// The hostname for the custom domain's regional endpoint.
	RegionalDomainName interface{}
	// The hosted zone ID that can be used to create a Route53 alias record for the regional endpoint.
	RegionalZoneId interface{}
}

Input properties used for looking up and filtering DomainName resources.

type GetResourceArgs added in v0.16.0

type GetResourceArgs struct {
	// The full path of the resource.  If no path is found, an error will be returned.
	Path interface{}
	// The REST API id that owns the resource. If no REST API is found, an error will be returned.
	RestApiId interface{}
}

A collection of arguments for invoking getResource.

type GetResourceResult added in v0.16.0

type GetResourceResult struct {
	// Set to the ID of the parent Resource.
	ParentId interface{}
	// Set to the path relative to the parent Resource.
	PathPart interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getResource.

func LookupResource added in v0.16.0

func LookupResource(ctx *pulumi.Context, args *GetResourceArgs) (*GetResourceResult, error)

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

type GetRestApiArgs

type GetRestApiArgs struct {
	// The name of the REST API to look up. If no REST API is found with this name, an error will be returned.
	// If multiple REST APIs are found with this name, an error will be returned.
	Name interface{}
}

A collection of arguments for invoking getRestApi.

type GetRestApiResult

type GetRestApiResult struct {
	// Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'.
	RootResourceId interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getRestApi.

func LookupRestApi

func LookupRestApi(ctx *pulumi.Context, args *GetRestApiArgs) (*GetRestApiResult, error)

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

type Integration

type Integration struct {
	// contains filtered or unexported fields
}

Provides an HTTP Method Integration for an API Gateway Integration.

func GetIntegration

func GetIntegration(ctx *pulumi.Context,
	name string, id pulumi.ID, state *IntegrationState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*Integration, error)

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

func (*Integration) CacheKeyParameters

func (r *Integration) CacheKeyParameters() *pulumi.ArrayOutput

A list of cache key parameters for the integration.

func (*Integration) CacheNamespace

func (r *Integration) CacheNamespace() *pulumi.StringOutput

The integration's cache namespace.

func (*Integration) ConnectionId

func (r *Integration) ConnectionId() *pulumi.StringOutput

The id of the VpcLink used for the integration. **Required** if `connection_type` is `VPC_LINK`

func (*Integration) ConnectionType

func (r *Integration) ConnectionType() *pulumi.StringOutput

The integration input's [connectionType](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#connectionType). Valid values are `INTERNET` (default for connections through the public routable internet), and `VPC_LINK` (for private connections between API Gateway and a network load balancer in a VPC).

func (*Integration) ContentHandling

func (r *Integration) ContentHandling() *pulumi.StringOutput

Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

func (*Integration) Credentials

func (r *Integration) Credentials() *pulumi.StringOutput

The credentials required for the integration. For `AWS` integrations, 2 options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's ARN. To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\*:user/\*`.

func (*Integration) HttpMethod

func (r *Integration) HttpMethod() *pulumi.StringOutput

The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`, `ANY`) when calling the associated resource.

func (*Integration) ID

func (r *Integration) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Integration) IntegrationHttpMethod

func (r *Integration) IntegrationHttpMethod() *pulumi.StringOutput

The integration HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`) specifying how API Gateway will interact with the back end. **Required** if `type` is `AWS`, `AWS_PROXY`, `HTTP` or `HTTP_PROXY`. Not all methods are compatible with all `AWS` integrations. e.g. Lambda function [can only be invoked](https://github.com/awslabs/aws-apigateway-importer/issues/9#issuecomment-129651005) via `POST`.

func (*Integration) PassthroughBehavior

func (r *Integration) PassthroughBehavior() *pulumi.StringOutput

The integration passthrough behavior (`WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, `NEVER`). **Required** if `request_templates` is used.

func (*Integration) RequestParameters

func (r *Integration) RequestParameters() *pulumi.MapOutput

A map of request query string parameters and headers that should be passed to the backend responder. For example: `request_parameters = { "integration.request.header.X-Some-Other-Header" = "method.request.header.X-Some-Header" }`

func (*Integration) RequestParametersInJson

func (r *Integration) RequestParametersInJson() *pulumi.StringOutput

**Deprecated**, use `request_parameters` instead.

func (*Integration) RequestTemplates

func (r *Integration) RequestTemplates() *pulumi.MapOutput

A map of the integration's request templates.

func (*Integration) ResourceId

func (r *Integration) ResourceId() *pulumi.StringOutput

The API resource ID.

func (*Integration) RestApi

func (r *Integration) RestApi() *pulumi.StringOutput

The ID of the associated REST API.

func (*Integration) TimeoutMilliseconds added in v0.15.1

func (r *Integration) TimeoutMilliseconds() *pulumi.IntOutput

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

func (*Integration) Type

func (r *Integration) Type() *pulumi.StringOutput

The integration input's [type](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/). Valid values are `HTTP` (for HTTP backends), `MOCK` (not calling any real backend), `AWS` (for AWS services), `AWS_PROXY` (for Lambda proxy integration) and `HTTP_PROXY` (for HTTP proxy integration). An `HTTP` or `HTTP_PROXY` integration with a `connection_type` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

func (*Integration) URN

func (r *Integration) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Integration) Uri

func (r *Integration) Uri() *pulumi.StringOutput

The input's URI (HTTP, AWS). **Required** if `type` is `HTTP` or `AWS`. For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification . For AWS integrations, the URI should be of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}`. `region`, `subdomain` and `service` are used to determine the right endpoint. e.g. `arn:aws:apigateway:eu-west-1:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-1:012345678901:function:my-func/invocations`

type IntegrationArgs

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

The set of arguments for constructing a Integration resource.

type IntegrationResponse

type IntegrationResponse struct {
	// contains filtered or unexported fields
}

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

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

func GetIntegrationResponse

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

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

func NewIntegrationResponse

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

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

func (*IntegrationResponse) ContentHandling

func (r *IntegrationResponse) ContentHandling() *pulumi.StringOutput

Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

func (*IntegrationResponse) HttpMethod

func (r *IntegrationResponse) HttpMethod() *pulumi.StringOutput

The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)

func (*IntegrationResponse) ID

ID is this resource's unique identifier assigned by its provider.

func (*IntegrationResponse) ResourceId

func (r *IntegrationResponse) ResourceId() *pulumi.StringOutput

The API resource ID

func (*IntegrationResponse) ResponseParameters

func (r *IntegrationResponse) ResponseParameters() *pulumi.MapOutput

A map of response parameters that can be read from the backend response. For example: `response_parameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }`,

func (*IntegrationResponse) ResponseParametersInJson

func (r *IntegrationResponse) ResponseParametersInJson() *pulumi.StringOutput

**Deprecated**, use `response_parameters` instead.

func (*IntegrationResponse) ResponseTemplates

func (r *IntegrationResponse) ResponseTemplates() *pulumi.MapOutput

A map specifying the templates used to transform the integration response body

func (*IntegrationResponse) RestApi

func (r *IntegrationResponse) RestApi() *pulumi.StringOutput

The ID of the associated REST API

func (*IntegrationResponse) SelectionPattern

func (r *IntegrationResponse) SelectionPattern() *pulumi.StringOutput

Specifies the regular expression pattern used to choose an integration response based on the response from the backend. Setting this to `-` makes the integration the default one. If the backend is an `AWS` Lambda function, the AWS Lambda function error header is matched. For all other `HTTP` and `AWS` backends, the HTTP status code is matched.

func (*IntegrationResponse) StatusCode

func (r *IntegrationResponse) StatusCode() *pulumi.StringOutput

The HTTP status code

func (*IntegrationResponse) URN

URN is this resource's unique name assigned by Pulumi.

type IntegrationResponseArgs

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

The set of arguments for constructing a IntegrationResponse resource.

type IntegrationResponseState

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

Input properties used for looking up and filtering IntegrationResponse resources.

type IntegrationState

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

Input properties used for looking up and filtering Integration resources.

type Method

type Method struct {
	// contains filtered or unexported fields
}

Provides a HTTP Method for an API Gateway Resource.

func GetMethod

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

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

func NewMethod

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

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

func (*Method) ApiKeyRequired

func (r *Method) ApiKeyRequired() *pulumi.BoolOutput

Specify if the method requires an API key

func (*Method) Authorization

func (r *Method) Authorization() *pulumi.StringOutput

The type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)

func (*Method) AuthorizationScopes

func (r *Method) AuthorizationScopes() *pulumi.ArrayOutput

The authorization scopes used when the authorization is `COGNITO_USER_POOLS`

func (*Method) AuthorizerId

func (r *Method) AuthorizerId() *pulumi.StringOutput

The authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`

func (*Method) HttpMethod

func (r *Method) HttpMethod() *pulumi.StringOutput

The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)

func (*Method) ID

func (r *Method) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Method) RequestModels

func (r *Method) RequestModels() *pulumi.MapOutput

A map of the API models used for the request's content type where key is the content type (e.g. `application/json`) and value is either `Error`, `Empty` (built-in models) or `aws_api_gateway_model`'s `name`.

func (*Method) RequestParameters

func (r *Method) RequestParameters() *pulumi.MapOutput

A map of request query string parameters and headers that should be passed to the integration. For example: ```hcl request_parameters = { "method.request.header.X-Some-Header" = true, "method.request.querystring.some-query-param" = true, } ``` would define that the header `X-Some-Header` and the query string `some-query-param` must be provided on the request, or

func (*Method) RequestParametersInJson

func (r *Method) RequestParametersInJson() *pulumi.StringOutput

**Deprecated**, use `request_parameters` instead.

func (*Method) RequestValidatorId

func (r *Method) RequestValidatorId() *pulumi.StringOutput

The ID of a `aws_api_gateway_request_validator`

func (*Method) ResourceId

func (r *Method) ResourceId() *pulumi.StringOutput

The API resource ID

func (*Method) RestApi

func (r *Method) RestApi() *pulumi.StringOutput

The ID of the associated REST API

func (*Method) URN

func (r *Method) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type MethodArgs

type MethodArgs struct {
	// Specify if the method requires an API key
	ApiKeyRequired interface{}
	// The type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization interface{}
	// The authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes interface{}
	// The authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId interface{}
	// The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod interface{}
	// A map of the API models used for the request's content type
	// where key is the content type (e.g. `application/json`)
	// and value is either `Error`, `Empty` (built-in models) or `aws_api_gateway_model`'s `name`.
	RequestModels interface{}
	// A map of request query string parameters and headers that should be passed to the integration.
	// For example:
	// “`hcl
	// request_parameters = {
	// "method.request.header.X-Some-Header" = true,
	// "method.request.querystring.some-query-param"  = true,
	// }
	// “`
	// would define that the header `X-Some-Header` and the query string `some-query-param` must be provided on the request, or
	RequestParameters interface{}
	// **Deprecated**, use `request_parameters` instead.
	RequestParametersInJson interface{}
	// The ID of a `aws_api_gateway_request_validator`
	RequestValidatorId interface{}
	// The API resource ID
	ResourceId interface{}
	// The ID of the associated REST API
	RestApi interface{}
}

The set of arguments for constructing a Method resource.

type MethodResponse

type MethodResponse struct {
	// contains filtered or unexported fields
}

Provides an HTTP Method Response for an API Gateway Resource.

func GetMethodResponse

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

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

func NewMethodResponse

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

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

func (*MethodResponse) HttpMethod

func (r *MethodResponse) HttpMethod() *pulumi.StringOutput

The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)

func (*MethodResponse) ID

func (r *MethodResponse) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*MethodResponse) ResourceId

func (r *MethodResponse) ResourceId() *pulumi.StringOutput

The API resource ID

func (*MethodResponse) ResponseModels

func (r *MethodResponse) ResponseModels() *pulumi.MapOutput

A map of the API models used for the response's content type

func (*MethodResponse) ResponseParameters

func (r *MethodResponse) ResponseParameters() *pulumi.MapOutput

A map of response parameters that can be sent to the caller. For example: `response_parameters = { "method.response.header.X-Some-Header" = true }` would define that the header `X-Some-Header` can be provided on the response.

func (*MethodResponse) ResponseParametersInJson

func (r *MethodResponse) ResponseParametersInJson() *pulumi.StringOutput

**Deprecated**, use `response_parameters` instead.

func (*MethodResponse) RestApi

func (r *MethodResponse) RestApi() *pulumi.StringOutput

The ID of the associated REST API

func (*MethodResponse) StatusCode

func (r *MethodResponse) StatusCode() *pulumi.StringOutput

The HTTP status code

func (*MethodResponse) URN

func (r *MethodResponse) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type MethodResponseArgs

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

The set of arguments for constructing a MethodResponse resource.

type MethodResponseState

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

Input properties used for looking up and filtering MethodResponse resources.

type MethodSettings

type MethodSettings struct {
	// contains filtered or unexported fields
}

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

func GetMethodSettings

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

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

func NewMethodSettings

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

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

func (*MethodSettings) ID

func (r *MethodSettings) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*MethodSettings) MethodPath

func (r *MethodSettings) MethodPath() *pulumi.StringOutput

Method path defined as `{resource_path}/{http_method}` for an individual method override, or `*/*` for overriding all methods in the stage.

func (*MethodSettings) RestApi

func (r *MethodSettings) RestApi() *pulumi.StringOutput

The ID of the REST API

func (*MethodSettings) Settings

func (r *MethodSettings) Settings() *pulumi.Output

The settings block, see below.

func (*MethodSettings) StageName

func (r *MethodSettings) StageName() *pulumi.StringOutput

The name of the stage

func (*MethodSettings) URN

func (r *MethodSettings) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type MethodSettingsArgs

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

The set of arguments for constructing a MethodSettings resource.

type MethodSettingsState

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

Input properties used for looking up and filtering MethodSettings resources.

type MethodState

type MethodState struct {
	// Specify if the method requires an API key
	ApiKeyRequired interface{}
	// The type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization interface{}
	// The authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes interface{}
	// The authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId interface{}
	// The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod interface{}
	// A map of the API models used for the request's content type
	// where key is the content type (e.g. `application/json`)
	// and value is either `Error`, `Empty` (built-in models) or `aws_api_gateway_model`'s `name`.
	RequestModels interface{}
	// A map of request query string parameters and headers that should be passed to the integration.
	// For example:
	// “`hcl
	// request_parameters = {
	// "method.request.header.X-Some-Header" = true,
	// "method.request.querystring.some-query-param"  = true,
	// }
	// “`
	// would define that the header `X-Some-Header` and the query string `some-query-param` must be provided on the request, or
	RequestParameters interface{}
	// **Deprecated**, use `request_parameters` instead.
	RequestParametersInJson interface{}
	// The ID of a `aws_api_gateway_request_validator`
	RequestValidatorId interface{}
	// The API resource ID
	ResourceId interface{}
	// The ID of the associated REST API
	RestApi interface{}
}

Input properties used for looking up and filtering Method resources.

type Model

type Model struct {
	// contains filtered or unexported fields
}

Provides a Model for a API Gateway.

func GetModel

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

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

func NewModel

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

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

func (*Model) ContentType

func (r *Model) ContentType() *pulumi.StringOutput

The content type of the model

func (*Model) Description

func (r *Model) Description() *pulumi.StringOutput

The description of the model

func (*Model) ID

func (r *Model) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Model) Name

func (r *Model) Name() *pulumi.StringOutput

The name of the model

func (*Model) RestApi

func (r *Model) RestApi() *pulumi.StringOutput

The ID of the associated REST API

func (*Model) Schema

func (r *Model) Schema() *pulumi.StringOutput

The schema of the model in a JSON form

func (*Model) URN

func (r *Model) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ModelArgs

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

The set of arguments for constructing a Model resource.

type ModelState

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

Input properties used for looking up and filtering Model resources.

type RequestValidator

type RequestValidator struct {
	// contains filtered or unexported fields
}

Manages an API Gateway Request Validator.

func GetRequestValidator

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

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

func NewRequestValidator

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

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

func (*RequestValidator) ID

func (r *RequestValidator) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*RequestValidator) Name

The name of the request validator

func (*RequestValidator) RestApi

func (r *RequestValidator) RestApi() *pulumi.StringOutput

The ID of the associated Rest API

func (*RequestValidator) URN

func (r *RequestValidator) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*RequestValidator) ValidateRequestBody

func (r *RequestValidator) ValidateRequestBody() *pulumi.BoolOutput

Boolean whether to validate request body. Defaults to `false`.

func (*RequestValidator) ValidateRequestParameters

func (r *RequestValidator) ValidateRequestParameters() *pulumi.BoolOutput

Boolean whether to validate request parameters. Defaults to `false`.

type RequestValidatorArgs

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

The set of arguments for constructing a RequestValidator resource.

type RequestValidatorState

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

Input properties used for looking up and filtering RequestValidator resources.

type Resource

type Resource struct {
	// contains filtered or unexported fields
}

Provides an API Gateway Resource.

func GetResource

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

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

func NewResource

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

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

func (*Resource) ID

func (r *Resource) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Resource) ParentId

func (r *Resource) ParentId() *pulumi.StringOutput

The ID of the parent API resource

func (*Resource) Path

func (r *Resource) Path() *pulumi.StringOutput

The complete path for this API resource, including all parent paths.

func (*Resource) PathPart

func (r *Resource) PathPart() *pulumi.StringOutput

The last path segment of this API resource.

func (*Resource) RestApi

func (r *Resource) RestApi() *pulumi.StringOutput

The ID of the associated REST API

func (*Resource) URN

func (r *Resource) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ResourceArgs

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

The set of arguments for constructing a Resource resource.

type ResourceState

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

Input properties used for looking up and filtering Resource resources.

type Response

type Response struct {
	// contains filtered or unexported fields
}

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

func GetResponse

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

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

func NewResponse

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

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

func (*Response) ID

func (r *Response) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Response) ResponseParameters

func (r *Response) ResponseParameters() *pulumi.MapOutput

A map specifying the templates used to transform the response body.

func (*Response) ResponseTemplates

func (r *Response) ResponseTemplates() *pulumi.MapOutput

A map specifying the parameters (paths, query strings and headers) of the Gateway Response.

func (*Response) ResponseType

func (r *Response) ResponseType() *pulumi.StringOutput

The response type of the associated GatewayResponse.

func (*Response) RestApiId

func (r *Response) RestApiId() *pulumi.StringOutput

The string identifier of the associated REST API.

func (*Response) StatusCode

func (r *Response) StatusCode() *pulumi.StringOutput

The HTTP status code of the Gateway Response.

func (*Response) URN

func (r *Response) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ResponseArgs

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

The set of arguments for constructing a Response resource.

type ResponseState

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

Input properties used for looking up and filtering Response resources.

type RestApi

type RestApi struct {
	// contains filtered or unexported fields
}

Provides an API Gateway REST API.

func GetRestApi

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

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

func NewRestApi

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

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

func (*RestApi) ApiKeySource

func (r *RestApi) ApiKeySource() *pulumi.StringOutput

The source of the API key for requests. Valid values are HEADER (default) and AUTHORIZER.

func (*RestApi) BinaryMediaTypes

func (r *RestApi) BinaryMediaTypes() *pulumi.ArrayOutput

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

func (*RestApi) Body

func (r *RestApi) Body() *pulumi.StringOutput

An OpenAPI specification that defines the set of routes and integrations to create as part of the REST API.

func (*RestApi) CreatedDate

func (r *RestApi) CreatedDate() *pulumi.StringOutput

The creation date of the REST API

func (*RestApi) Description

func (r *RestApi) Description() *pulumi.StringOutput

The description of the REST API

func (*RestApi) EndpointConfiguration

func (r *RestApi) EndpointConfiguration() *pulumi.Output

Nested argument defining API endpoint configuration including endpoint type. Defined below.

func (*RestApi) ExecutionArn

func (r *RestApi) ExecutionArn() *pulumi.StringOutput

The execution ARN part to be used in [`lambda_permission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `source_arn` when allowing API Gateway to invoke a Lambda function, e.g. `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j`, which can be concatenated with allowed stage, method and resource path.

func (*RestApi) ID

func (r *RestApi) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*RestApi) MinimumCompressionSize

func (r *RestApi) MinimumCompressionSize() *pulumi.IntOutput

Minimum response size to compress for the REST API. Integer between -1 and 10485760 (10MB). Setting a value greater than -1 will enable compression, -1 disables compression (default).

func (*RestApi) Name

func (r *RestApi) Name() *pulumi.StringOutput

The name of the REST API

func (*RestApi) Policy

func (r *RestApi) Policy() *pulumi.StringOutput

JSON formatted policy document that controls access to the API Gateway

func (*RestApi) RootResourceId

func (r *RestApi) RootResourceId() *pulumi.StringOutput

The resource ID of the REST API's root

func (*RestApi) URN

func (r *RestApi) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type RestApiArgs

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

The set of arguments for constructing a RestApi resource.

type RestApiState

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

Input properties used for looking up and filtering RestApi resources.

type Stage

type Stage struct {
	// contains filtered or unexported fields
}

Provides an API Gateway Stage.

func GetStage

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

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

func NewStage

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

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

func (*Stage) AccessLogSettings

func (r *Stage) AccessLogSettings() *pulumi.Output

Enables access logs for the API stage. Detailed below.

func (*Stage) CacheClusterEnabled

func (r *Stage) CacheClusterEnabled() *pulumi.BoolOutput

Specifies whether a cache cluster is enabled for the stage

func (*Stage) CacheClusterSize

func (r *Stage) CacheClusterSize() *pulumi.StringOutput

The size of the cache cluster for the stage, if enabled. Allowed values include `0.5`, `1.6`, `6.1`, `13.5`, `28.4`, `58.2`, `118` and `237`.

func (*Stage) ClientCertificateId

func (r *Stage) ClientCertificateId() *pulumi.StringOutput

The identifier of a client certificate for the stage.

func (*Stage) Deployment

func (r *Stage) Deployment() *pulumi.StringOutput

The ID of the deployment that the stage points to

func (*Stage) Description

func (r *Stage) Description() *pulumi.StringOutput

The description of the stage

func (*Stage) DocumentationVersion

func (r *Stage) DocumentationVersion() *pulumi.StringOutput

The version of the associated API documentation

func (*Stage) ExecutionArn

func (r *Stage) ExecutionArn() *pulumi.StringOutput

The execution ARN to be used in [`lambda_permission`](https://www.terraform.io/docs/providers/aws/r/lambda_permission.html)'s `source_arn` when allowing API Gateway to invoke a Lambda function, e.g. `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod`

func (*Stage) ID

func (r *Stage) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Stage) InvokeUrl

func (r *Stage) InvokeUrl() *pulumi.StringOutput

The URL to invoke the API pointing to the stage, e.g. `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod`

func (*Stage) RestApi

func (r *Stage) RestApi() *pulumi.StringOutput

The ID of the associated REST API

func (*Stage) StageName

func (r *Stage) StageName() *pulumi.StringOutput

The name of the stage

func (*Stage) Tags

func (r *Stage) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Stage) URN

func (r *Stage) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Stage) Variables

func (r *Stage) Variables() *pulumi.MapOutput

A map that defines the stage variables

func (*Stage) XrayTracingEnabled added in v0.16.0

func (r *Stage) XrayTracingEnabled() *pulumi.BoolOutput

Whether active tracing with X-ray is enabled. Defaults to `false`.

type StageArgs

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

The set of arguments for constructing a Stage resource.

type StageState

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

Input properties used for looking up and filtering Stage resources.

type UsagePlan

type UsagePlan struct {
	// contains filtered or unexported fields
}

Provides an API Gateway Usage Plan.

func GetUsagePlan

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

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

func NewUsagePlan

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

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

func (*UsagePlan) ApiStages

func (r *UsagePlan) ApiStages() *pulumi.ArrayOutput

The associated API stages of the usage plan.

func (*UsagePlan) Description

func (r *UsagePlan) Description() *pulumi.StringOutput

The description of a usage plan.

func (*UsagePlan) ID

func (r *UsagePlan) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*UsagePlan) Name

func (r *UsagePlan) Name() *pulumi.StringOutput

The name of the usage plan.

func (*UsagePlan) ProductCode

func (r *UsagePlan) ProductCode() *pulumi.StringOutput

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

func (*UsagePlan) QuotaSettings

func (r *UsagePlan) QuotaSettings() *pulumi.Output

The quota settings of the usage plan.

func (*UsagePlan) ThrottleSettings

func (r *UsagePlan) ThrottleSettings() *pulumi.Output

The throttling limits of the usage plan.

func (*UsagePlan) URN

func (r *UsagePlan) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type UsagePlanArgs

type UsagePlanArgs struct {
	// The associated API stages of the usage plan.
	ApiStages interface{}
	// The description of a usage plan.
	Description interface{}
	// The name of the usage plan.
	Name interface{}
	// The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
	ProductCode interface{}
	// The quota settings of the usage plan.
	QuotaSettings interface{}
	// The throttling limits of the usage plan.
	ThrottleSettings interface{}
}

The set of arguments for constructing a UsagePlan resource.

type UsagePlanKey

type UsagePlanKey struct {
	// contains filtered or unexported fields
}

Provides an API Gateway Usage Plan Key.

func GetUsagePlanKey

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

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

func NewUsagePlanKey

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

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

func (*UsagePlanKey) ID

func (r *UsagePlanKey) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*UsagePlanKey) KeyId

func (r *UsagePlanKey) KeyId() *pulumi.StringOutput

The identifier of the API key resource.

func (*UsagePlanKey) KeyType

func (r *UsagePlanKey) KeyType() *pulumi.StringOutput

The type of the API key resource. Currently, the valid key type is API_KEY.

func (*UsagePlanKey) Name

func (r *UsagePlanKey) Name() *pulumi.StringOutput

The name of a usage plan key.

func (*UsagePlanKey) URN

func (r *UsagePlanKey) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*UsagePlanKey) UsagePlanId

func (r *UsagePlanKey) UsagePlanId() *pulumi.StringOutput

The Id of the usage plan resource representing to associate the key to.

func (*UsagePlanKey) Value

func (r *UsagePlanKey) Value() *pulumi.StringOutput

The value of a usage plan key.

type UsagePlanKeyArgs

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

The set of arguments for constructing a UsagePlanKey resource.

type UsagePlanKeyState

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

Input properties used for looking up and filtering UsagePlanKey resources.

type UsagePlanState

type UsagePlanState struct {
	// The associated API stages of the usage plan.
	ApiStages interface{}
	// The description of a usage plan.
	Description interface{}
	// The name of the usage plan.
	Name interface{}
	// The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
	ProductCode interface{}
	// The quota settings of the usage plan.
	QuotaSettings interface{}
	// The throttling limits of the usage plan.
	ThrottleSettings interface{}
}

Input properties used for looking up and filtering UsagePlan resources.

type VpcLink struct {
	// contains filtered or unexported fields
}

Provides an API Gateway VPC Link.

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

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

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

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

func (*VpcLink) Description

func (r *VpcLink) Description() *pulumi.StringOutput

The description of the VPC link.

func (*VpcLink) ID

func (r *VpcLink) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*VpcLink) Name

func (r *VpcLink) Name() *pulumi.StringOutput

The name used to label and identify the VPC link.

func (*VpcLink) TargetArn

func (r *VpcLink) TargetArn() *pulumi.StringOutput

The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.

func (*VpcLink) URN

func (r *VpcLink) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type VpcLinkArgs

type VpcLinkArgs struct {
	// The description of the VPC link.
	Description interface{}
	// The name used to label and identify the VPC link.
	Name interface{}
	// The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
	TargetArn interface{}
}

The set of arguments for constructing a VpcLink resource.

type VpcLinkState

type VpcLinkState struct {
	// The description of the VPC link.
	Description interface{}
	// The name used to label and identify the VPC link.
	Name interface{}
	// The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
	TargetArn interface{}
}

Input properties used for looking up and filtering VpcLink resources.

Jump to

Keyboard shortcuts

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