Documentation
¶
Overview ¶
+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the apigatewayv2.services.k8s.aws API. +groupName=apigatewayv2.services.k8s.aws
Index ¶
- Variables
- type API
- type APIList
- type APIMapping
- type APIMappingList
- type APIMappingSpec
- type APIMappingStatus
- type APIMapping_SDK
- type APISpec
- type APIStatus
- type API_SDK
- type AccessLogSettings
- type AuthorizationType
- type Authorizer
- type AuthorizerList
- type AuthorizerSpec
- type AuthorizerStatus
- type AuthorizerType
- type Authorizer_SDK
- type CORS
- type ConnectionType
- type ContentHandlingStrategy
- type Deployment
- type DeploymentList
- type DeploymentSpec
- type DeploymentStatus
- type DeploymentStatus_SDK
- type Deployment_SDK
- type DomainName
- type DomainNameConfiguration
- type DomainNameList
- type DomainNameSpec
- type DomainNameStatus
- type DomainNameStatus_SDK
- type DomainName_SDK
- type EndpointType
- type Integration
- type IntegrationList
- type IntegrationResponse
- type IntegrationSpec
- type IntegrationStatus
- type IntegrationType
- type Integration_SDK
- type JWTConfiguration
- type LoggingLevel
- type Model
- type MutualTLSAuthentication
- type MutualTLSAuthenticationInput
- type ParameterConstraints
- type PassthroughBehavior
- type ProtocolType
- type Route
- type RouteList
- type RouteResponse
- type RouteSettings
- type RouteSpec
- type RouteStatus
- type Route_SDK
- type SecurityPolicy
- type Stage
- type StageList
- type StageSpec
- type StageStatus
- type Stage_SDK
- type TLSConfig
- type TLSConfigInput
- type VPCLink
- type VPCLinkList
- type VPCLinkSpec
- type VPCLinkStatus
- type VPCLinkStatus_SDK
- type VPCLinkVersion
- type VPCLink_SDK
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is the API Group Version used to register the objects GroupVersion = schema.GroupVersion{Group: "apigatewayv2.services.k8s.aws", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec APISpec `json:"spec,omitempty"` Status APIStatus `json:"status,omitempty"` }
API is the Schema for the APIS API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*API) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new API.
func (*API) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*API) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type APIList ¶
type APIList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []API `json:"items"` }
APIList contains a list of API +kubebuilder:object:root=true
func (*APIList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIList.
func (*APIList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type APIMapping ¶
type APIMapping struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec APIMappingSpec `json:"spec,omitempty"` Status APIMappingStatus `json:"status,omitempty"` }
APIMapping is the Schema for the APIMappings API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*APIMapping) DeepCopy ¶
func (in *APIMapping) DeepCopy() *APIMapping
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIMapping.
func (*APIMapping) DeepCopyInto ¶
func (in *APIMapping) DeepCopyInto(out *APIMapping)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIMapping) DeepCopyObject ¶
func (in *APIMapping) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type APIMappingList ¶
type APIMappingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []APIMapping `json:"items"` }
APIMappingList contains a list of APIMapping +kubebuilder:object:root=true
func (*APIMappingList) DeepCopy ¶
func (in *APIMappingList) DeepCopy() *APIMappingList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIMappingList.
func (*APIMappingList) DeepCopyInto ¶
func (in *APIMappingList) DeepCopyInto(out *APIMappingList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIMappingList) DeepCopyObject ¶
func (in *APIMappingList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type APIMappingSpec ¶
type APIMappingSpec struct { // The API identifier. APIID *string `json:"apiID,omitempty"` // The API mapping key. APIMappingKey *string `json:"apiMappingKey,omitempty"` APIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"apiRef,omitempty"` // The domain name. DomainName *string `json:"domainName,omitempty"` DomainRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"domainRef,omitempty"` // The API stage. // +kubebuilder:validation:Required Stage *string `json:"stage"` }
ApiMappingSpec defines the desired state of ApiMapping.
Represents an API mapping.
func (*APIMappingSpec) DeepCopy ¶
func (in *APIMappingSpec) DeepCopy() *APIMappingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIMappingSpec.
func (*APIMappingSpec) DeepCopyInto ¶
func (in *APIMappingSpec) DeepCopyInto(out *APIMappingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type APIMappingStatus ¶
type APIMappingStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // The API mapping identifier. // +kubebuilder:validation:Optional APIMappingID *string `json:"apiMappingID,omitempty"` }
APIMappingStatus defines the observed state of APIMapping
func (*APIMappingStatus) DeepCopy ¶
func (in *APIMappingStatus) DeepCopy() *APIMappingStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIMappingStatus.
func (*APIMappingStatus) DeepCopyInto ¶
func (in *APIMappingStatus) DeepCopyInto(out *APIMappingStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type APIMapping_SDK ¶
type APIMapping_SDK struct { // The identifier. APIID *string `json:"apiID,omitempty"` // The identifier. APIMappingID *string `json:"apiMappingID,omitempty"` // After evaluating a selection expression, the result is compared against one // or more selection keys to find a matching key. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for a list of expressions and each expression's associated selection key // type. APIMappingKey *string `json:"apiMappingKey,omitempty"` // A string with a length between [1-128]. Stage *string `json:"stage,omitempty"` }
Represents an API mapping.
func (*APIMapping_SDK) DeepCopy ¶
func (in *APIMapping_SDK) DeepCopy() *APIMapping_SDK
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIMapping_SDK.
func (*APIMapping_SDK) DeepCopyInto ¶
func (in *APIMapping_SDK) DeepCopyInto(out *APIMapping_SDK)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type APISpec ¶
type APISpec struct { // An API key selection expression. Supported only for WebSocket APIs. See API // Key Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). APIKeySelectionExpression *string `json:"apiKeySelectionExpression,omitempty"` // Specifies how to interpret the base path of the API during import. Valid // values are ignore, prepend, and split. The default value is ignore. To learn // more, see Set the OpenAPI basePath Property (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). // Supported only for HTTP APIs. Basepath *string `json:"basepath,omitempty"` // The OpenAPI definition. Supported only for HTTP APIs. Body *string `json:"body,omitempty"` // A CORS configuration. Supported only for HTTP APIs. See Configuring CORS // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) // for more information. CORSConfiguration *CORS `json:"corsConfiguration,omitempty"` // This property is part of quick create. It specifies the credentials required // for the integration, if any. For a Lambda integration, three options are // available. To specify an IAM Role for API Gateway to assume, use the role's // Amazon Resource Name (ARN). To require that the caller's identity be passed // through from the request, specify arn:aws:iam::*:user/*. To use resource-based // permissions on supported AWS services, specify null. Currently, this property // is not used for HTTP integrations. Supported only for HTTP APIs. CredentialsARN *string `json:"credentialsARN,omitempty"` // The description of the API. Description *string `json:"description,omitempty"` // Specifies whether clients can invoke your API by using the default execute-api // endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com // endpoint. To require that clients use a custom domain name to invoke your // API, disable the default endpoint. DisableExecuteAPIEndpoint *bool `json:"disableExecuteAPIEndpoint,omitempty"` // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool `json:"disableSchemaValidation,omitempty"` // Specifies whether to rollback the API creation when a warning is encountered. // By default, API creation continues if a warning is encountered. FailOnWarnings *bool `json:"failOnWarnings,omitempty"` // The name of the API. Name *string `json:"name,omitempty"` // The API protocol. ProtocolType *string `json:"protocolType,omitempty"` // This property is part of quick create. If you don't specify a routeKey, a // default route of $default is created. The $default route acts as a catch-all // for any request made to your API, for a particular stage. The $default route // key can't be modified. You can add routes after creating the API, and you // can update the route keys of additional routes. Supported only for HTTP APIs. RouteKey *string `json:"routeKey,omitempty"` // The route selection expression for the API. For HTTP APIs, the routeSelectionExpression // must be ${request.method} ${request.path}. If not provided, this will be // the default for HTTP APIs. This property is required for WebSocket APIs. RouteSelectionExpression *string `json:"routeSelectionExpression,omitempty"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string `json:"tags,omitempty"` // This property is part of quick create. Quick create produces an API with // an integration, a default catch-all route, and a default stage which is configured // to automatically deploy changes. For HTTP integrations, specify a fully qualified // URL. For Lambda integrations, specify a function ARN. The type of the integration // will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs. Target *string `json:"target,omitempty"` // A version identifier for the API. Version *string `json:"version,omitempty"` }
ApiSpec defines the desired state of Api.
Represents an API.
func (*APISpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APISpec.
func (*APISpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type APIStatus ¶
type APIStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. // The stage name is typically appended to this URI to form a complete path // to a deployed API stage. // +kubebuilder:validation:Optional APIEndpoint *string `json:"apiEndpoint,omitempty"` // Specifies whether an API is managed by API Gateway. You can't update or delete // a managed API by using API Gateway. A managed API can be deleted only through // the tooling or service that created it. // +kubebuilder:validation:Optional APIGatewayManaged *bool `json:"apiGatewayManaged,omitempty"` // The API ID. // +kubebuilder:validation:Optional APIID *string `json:"apiID,omitempty"` // The timestamp when the API was created. // +kubebuilder:validation:Optional CreatedDate *metav1.Time `json:"createdDate,omitempty"` // The validation information during API import. This may include particular // properties of your OpenAPI definition which are ignored during import. Supported // only for HTTP APIs. // +kubebuilder:validation:Optional ImportInfo []*string `json:"importInfo,omitempty"` // The warning messages reported when failonwarnings is turned on during API // import. // +kubebuilder:validation:Optional Warnings []*string `json:"warnings,omitempty"` }
APIStatus defines the observed state of API
func (*APIStatus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIStatus.
func (*APIStatus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type API_SDK ¶
type API_SDK struct { APIEndpoint *string `json:"apiEndpoint,omitempty"` APIGatewayManaged *bool `json:"apiGatewayManaged,omitempty"` // The identifier. APIID *string `json:"apiID,omitempty"` // An expression used to extract information at runtime. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for more information. APIKeySelectionExpression *string `json:"apiKeySelectionExpression,omitempty"` // Represents a CORS configuration. Supported only for HTTP APIs. See Configuring // CORS (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) // for more information. CORSConfiguration *CORS `json:"corsConfiguration,omitempty"` CreatedDate *metav1.Time `json:"createdDate,omitempty"` // A string with a length between [0-1024]. Description *string `json:"description,omitempty"` DisableExecuteAPIEndpoint *bool `json:"disableExecuteAPIEndpoint,omitempty"` DisableSchemaValidation *bool `json:"disableSchemaValidation,omitempty"` ImportInfo []*string `json:"importInfo,omitempty"` // A string with a length between [1-128]. Name *string `json:"name,omitempty"` // Represents a protocol type. ProtocolType *string `json:"protocolType,omitempty"` // An expression used to extract information at runtime. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for more information. RouteSelectionExpression *string `json:"routeSelectionExpression,omitempty"` // Represents a collection of tags associated with the resource. Tags map[string]*string `json:"tags,omitempty"` // A string with a length between [1-64]. Version *string `json:"version,omitempty"` Warnings []*string `json:"warnings,omitempty"` }
Represents an API.
func (*API_SDK) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new API_SDK.
func (*API_SDK) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AccessLogSettings ¶
type AccessLogSettings struct { // Represents an Amazon Resource Name (ARN). DestinationARN *string `json:"destinationARN,omitempty"` // A string with a length between [1-1024]. Format *string `json:"format,omitempty"` }
Settings for logging access in a stage.
func (*AccessLogSettings) DeepCopy ¶
func (in *AccessLogSettings) DeepCopy() *AccessLogSettings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessLogSettings.
func (*AccessLogSettings) DeepCopyInto ¶
func (in *AccessLogSettings) DeepCopyInto(out *AccessLogSettings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AuthorizationType ¶
type AuthorizationType string
const ( AuthorizationType_AWS_IAM AuthorizationType = "AWS_IAM" AuthorizationType_CUSTOM AuthorizationType = "CUSTOM" AuthorizationType_JWT AuthorizationType = "JWT" AuthorizationType_NONE AuthorizationType = "NONE" )
type Authorizer ¶
type Authorizer struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec AuthorizerSpec `json:"spec,omitempty"` Status AuthorizerStatus `json:"status,omitempty"` }
Authorizer is the Schema for the Authorizers API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Authorizer) DeepCopy ¶
func (in *Authorizer) DeepCopy() *Authorizer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Authorizer.
func (*Authorizer) DeepCopyInto ¶
func (in *Authorizer) DeepCopyInto(out *Authorizer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Authorizer) DeepCopyObject ¶
func (in *Authorizer) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AuthorizerList ¶
type AuthorizerList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Authorizer `json:"items"` }
AuthorizerList contains a list of Authorizer +kubebuilder:object:root=true
func (*AuthorizerList) DeepCopy ¶
func (in *AuthorizerList) DeepCopy() *AuthorizerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthorizerList.
func (*AuthorizerList) DeepCopyInto ¶
func (in *AuthorizerList) DeepCopyInto(out *AuthorizerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AuthorizerList) DeepCopyObject ¶
func (in *AuthorizerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AuthorizerSpec ¶
type AuthorizerSpec struct { // The API identifier. APIID *string `json:"apiID,omitempty"` APIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"apiRef,omitempty"` // Specifies the required credentials as an IAM role for API Gateway to invoke // the authorizer. To specify an IAM role for API Gateway to assume, use the // role's Amazon Resource Name (ARN). To use resource-based permissions on the // Lambda function, don't specify this parameter. Supported only for REQUEST // authorizers. AuthorizerCredentialsARN *string `json:"authorizerCredentialsARN,omitempty"` // Specifies the format of the payload sent to an HTTP API Lambda authorizer. // Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. // To learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). AuthorizerPayloadFormatVersion *string `json:"authorizerPayloadFormatVersion,omitempty"` // The time to live (TTL) for cached authorizer results, in seconds. If it equals // 0, authorization caching is disabled. If it is greater than 0, API Gateway // caches authorizer responses. The maximum value is 3600, or 1 hour. Supported // only for HTTP API Lambda authorizers. AuthorizerResultTTLInSeconds *int64 `json:"authorizerResultTTLInSeconds,omitempty"` // The authorizer type. Specify REQUEST for a Lambda function using incoming // request parameters. Specify JWT to use JSON Web Tokens (supported only for // HTTP APIs). // +kubebuilder:validation:Required AuthorizerType *string `json:"authorizerType"` // The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, // this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} // , where {region} is the same as the region hosting the Lambda function, path // indicates that the remaining substring in the URI should be treated as the // path to the resource, including the initial /. For Lambda functions, this // is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported // only for REQUEST authorizers. AuthorizerURI *string `json:"authorizerURI,omitempty"` // Specifies whether a Lambda authorizer returns a response in a simple format. // By default, a Lambda authorizer must return an IAM policy. If enabled, the // Lambda authorizer can return a boolean value instead of an IAM policy. Supported // only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers // for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) EnableSimpleResponses *bool `json:"enableSimpleResponses,omitempty"` // The identity source for which authorization is requested. // // For a REQUEST authorizer, this is optional. The value is a set of one or // more mapping expressions of the specified request parameters. The identity // source can be headers, query string parameters, stage variables, and context // parameters. For example, if an Auth header and a Name query string parameter // are defined as identity sources, this value is route.request.header.Auth, // route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection // expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. // These parameters are used to perform runtime validation for Lambda-based // authorizers by verifying all of the identity-related request parameters are // present in the request, not null, and non-empty. Only when this is true does // the authorizer invoke the authorizer Lambda function. Otherwise, it returns // a 401 Unauthorized response without calling the Lambda function. For HTTP // APIs, identity sources are also used as the cache key when caching is enabled. // To learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). // // For JWT, a single entry that specifies where to extract the JSON Web Token // (JWT) from inbound requests. Currently only header-based and query parameter-based // selections are supported, for example $request.header.Authorization. // +kubebuilder:validation:Required IdentitySource []*string `json:"identitySource"` // This parameter is not used. IdentityValidationExpression *string `json:"identityValidationExpression,omitempty"` // Represents the configuration of a JWT authorizer. Required for the JWT authorizer // type. Supported only for HTTP APIs. JWTConfiguration *JWTConfiguration `json:"jwtConfiguration,omitempty"` // The name of the authorizer. // +kubebuilder:validation:Required Name *string `json:"name"` }
AuthorizerSpec defines the desired state of Authorizer.
Represents an authorizer.
func (*AuthorizerSpec) DeepCopy ¶
func (in *AuthorizerSpec) DeepCopy() *AuthorizerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthorizerSpec.
func (*AuthorizerSpec) DeepCopyInto ¶
func (in *AuthorizerSpec) DeepCopyInto(out *AuthorizerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AuthorizerStatus ¶
type AuthorizerStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // The authorizer identifier. // +kubebuilder:validation:Optional AuthorizerID *string `json:"authorizerID,omitempty"` }
AuthorizerStatus defines the observed state of Authorizer
func (*AuthorizerStatus) DeepCopy ¶
func (in *AuthorizerStatus) DeepCopy() *AuthorizerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthorizerStatus.
func (*AuthorizerStatus) DeepCopyInto ¶
func (in *AuthorizerStatus) DeepCopyInto(out *AuthorizerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AuthorizerType ¶
type AuthorizerType string
const ( AuthorizerType_JWT AuthorizerType = "JWT" AuthorizerType_REQUEST AuthorizerType = "REQUEST" )
type Authorizer_SDK ¶
type Authorizer_SDK struct { // Represents an Amazon Resource Name (ARN). AuthorizerCredentialsARN *string `json:"authorizerCredentialsARN,omitempty"` // The identifier. AuthorizerID *string `json:"authorizerID,omitempty"` // A string with a length between [1-64]. AuthorizerPayloadFormatVersion *string `json:"authorizerPayloadFormatVersion,omitempty"` // An integer with a value between [0-3600]. AuthorizerResultTTLInSeconds *int64 `json:"authorizerResultTTLInSeconds,omitempty"` // The authorizer type. Specify REQUEST for a Lambda function using incoming // request parameters. Specify JWT to use JSON Web Tokens (supported only for // HTTP APIs). AuthorizerType *string `json:"authorizerType,omitempty"` // A string representation of a URI with a length between [1-2048]. AuthorizerURI *string `json:"authorizerURI,omitempty"` EnableSimpleResponses *bool `json:"enableSimpleResponses,omitempty"` // The identity source for which authorization is requested. For the REQUEST // authorizer, this is required when authorization caching is enabled. The value // is a comma-separated string of one or more mapping expressions of the specified // request parameters. For example, if an Auth header, a Name query string parameter // are defined as identity sources, this value is $method.request.header.Auth, // $method.request.querystring.Name. These parameters will be used to derive // the authorization caching key and to perform runtime validation of the REQUEST // authorizer by verifying all of the identity-related request parameters are // present, not null and non-empty. Only when this is true does the authorizer // invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized // response without calling the Lambda function. The valid value is a string // of comma-separated mapping expressions of the specified request parameters. // When the authorization caching is not enabled, this property is optional. IdentitySource []*string `json:"identitySource,omitempty"` // A string with a length between [0-1024]. IdentityValidationExpression *string `json:"identityValidationExpression,omitempty"` // Represents the configuration of a JWT authorizer. Required for the JWT authorizer // type. Supported only for HTTP APIs. JWTConfiguration *JWTConfiguration `json:"jwtConfiguration,omitempty"` // A string with a length between [1-128]. Name *string `json:"name,omitempty"` }
Represents an authorizer.
func (*Authorizer_SDK) DeepCopy ¶
func (in *Authorizer_SDK) DeepCopy() *Authorizer_SDK
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Authorizer_SDK.
func (*Authorizer_SDK) DeepCopyInto ¶
func (in *Authorizer_SDK) DeepCopyInto(out *Authorizer_SDK)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CORS ¶ added in v0.0.3
type CORS struct { AllowCredentials *bool `json:"allowCredentials,omitempty"` // Represents a collection of allowed headers. Supported only for HTTP APIs. AllowHeaders []*string `json:"allowHeaders,omitempty"` // Represents a collection of methods. Supported only for HTTP APIs. AllowMethods []*string `json:"allowMethods,omitempty"` // Represents a collection of origins. Supported only for HTTP APIs. AllowOrigins []*string `json:"allowOrigins,omitempty"` // Represents a collection of allowed headers. Supported only for HTTP APIs. ExposeHeaders []*string `json:"exposeHeaders,omitempty"` // An integer with a value between -1 and 86400. Supported only for HTTP APIs. MaxAge *int64 `json:"maxAge,omitempty"` }
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
func (*CORS) DeepCopy ¶ added in v0.0.3
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CORS.
func (*CORS) DeepCopyInto ¶ added in v0.0.3
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConnectionType ¶
type ConnectionType string
const ( ConnectionType_INTERNET ConnectionType = "INTERNET" ConnectionType_VPC_LINK ConnectionType = "VPC_LINK" )
type ContentHandlingStrategy ¶
type ContentHandlingStrategy string
const ( ContentHandlingStrategy_CONVERT_TO_BINARY ContentHandlingStrategy = "CONVERT_TO_BINARY" ContentHandlingStrategy_CONVERT_TO_TEXT ContentHandlingStrategy = "CONVERT_TO_TEXT" )
type Deployment ¶
type Deployment struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec DeploymentSpec `json:"spec,omitempty"` Status DeploymentStatus `json:"status,omitempty"` }
Deployment is the Schema for the Deployments API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Deployment) DeepCopy ¶
func (in *Deployment) DeepCopy() *Deployment
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Deployment.
func (*Deployment) DeepCopyInto ¶
func (in *Deployment) DeepCopyInto(out *Deployment)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Deployment) DeepCopyObject ¶
func (in *Deployment) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DeploymentList ¶
type DeploymentList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Deployment `json:"items"` }
DeploymentList contains a list of Deployment +kubebuilder:object:root=true
func (*DeploymentList) DeepCopy ¶
func (in *DeploymentList) DeepCopy() *DeploymentList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentList.
func (*DeploymentList) DeepCopyInto ¶
func (in *DeploymentList) DeepCopyInto(out *DeploymentList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DeploymentList) DeepCopyObject ¶
func (in *DeploymentList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DeploymentSpec ¶
type DeploymentSpec struct { // The API identifier. APIID *string `json:"apiID,omitempty"` APIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"apiRef,omitempty"` // The description for the deployment resource. Description *string `json:"description,omitempty"` // The name of the Stage resource for the Deployment resource to create. StageName *string `json:"stageName,omitempty"` }
DeploymentSpec defines the desired state of Deployment.
An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
func (*DeploymentSpec) DeepCopy ¶
func (in *DeploymentSpec) DeepCopy() *DeploymentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentSpec.
func (*DeploymentSpec) DeepCopyInto ¶
func (in *DeploymentSpec) DeepCopyInto(out *DeploymentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DeploymentStatus ¶
type DeploymentStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // Specifies whether a deployment was automatically released. // +kubebuilder:validation:Optional AutoDeployed *bool `json:"autoDeployed,omitempty"` // The date and time when the Deployment resource was created. // +kubebuilder:validation:Optional CreatedDate *metav1.Time `json:"createdDate,omitempty"` // The identifier for the deployment. // +kubebuilder:validation:Optional DeploymentID *string `json:"deploymentID,omitempty"` // The status of the deployment: PENDING, FAILED, or SUCCEEDED. // +kubebuilder:validation:Optional DeploymentStatus *string `json:"deploymentStatus,omitempty"` // May contain additional feedback on the status of an API deployment. // +kubebuilder:validation:Optional DeploymentStatusMessage *string `json:"deploymentStatusMessage,omitempty"` }
DeploymentStatus defines the observed state of Deployment
func (*DeploymentStatus) DeepCopy ¶
func (in *DeploymentStatus) DeepCopy() *DeploymentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentStatus.
func (*DeploymentStatus) DeepCopyInto ¶
func (in *DeploymentStatus) DeepCopyInto(out *DeploymentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DeploymentStatus_SDK ¶
type DeploymentStatus_SDK string
const ( DeploymentStatus_SDK_DEPLOYED DeploymentStatus_SDK = "DEPLOYED" DeploymentStatus_SDK_FAILED DeploymentStatus_SDK = "FAILED" DeploymentStatus_SDK_PENDING DeploymentStatus_SDK = "PENDING" )
type Deployment_SDK ¶
type Deployment_SDK struct { AutoDeployed *bool `json:"autoDeployed,omitempty"` CreatedDate *metav1.Time `json:"createdDate,omitempty"` // The identifier. DeploymentID *string `json:"deploymentID,omitempty"` // Represents a deployment status. DeploymentStatus *string `json:"deploymentStatus,omitempty"` DeploymentStatusMessage *string `json:"deploymentStatusMessage,omitempty"` // A string with a length between [0-1024]. Description *string `json:"description,omitempty"` }
An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
func (*Deployment_SDK) DeepCopy ¶
func (in *Deployment_SDK) DeepCopy() *Deployment_SDK
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Deployment_SDK.
func (*Deployment_SDK) DeepCopyInto ¶
func (in *Deployment_SDK) DeepCopyInto(out *Deployment_SDK)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DomainName ¶
type DomainName struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec DomainNameSpec `json:"spec,omitempty"` Status DomainNameStatus `json:"status,omitempty"` }
DomainName is the Schema for the DomainNames API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*DomainName) DeepCopy ¶
func (in *DomainName) DeepCopy() *DomainName
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DomainName.
func (*DomainName) DeepCopyInto ¶
func (in *DomainName) DeepCopyInto(out *DomainName)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DomainName) DeepCopyObject ¶
func (in *DomainName) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DomainNameConfiguration ¶
type DomainNameConfiguration struct { // Represents an Amazon Resource Name (ARN). CertificateARN *string `json:"certificateARN,omitempty"` // A string with a length between [1-128]. CertificateName *string `json:"certificateName,omitempty"` // Represents an endpoint type. EndpointType *string `json:"endpointType,omitempty"` // Represents an Amazon Resource Name (ARN). OwnershipVerificationCertificateARN *string `json:"ownershipVerificationCertificateARN,omitempty"` // The Transport Layer Security (TLS) version of the security policy for this // domain name. The valid values are TLS_1_0 and TLS_1_2. SecurityPolicy *string `json:"securityPolicy,omitempty"` }
The domain name configuration.
func (*DomainNameConfiguration) DeepCopy ¶
func (in *DomainNameConfiguration) DeepCopy() *DomainNameConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DomainNameConfiguration.
func (*DomainNameConfiguration) DeepCopyInto ¶
func (in *DomainNameConfiguration) DeepCopyInto(out *DomainNameConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DomainNameList ¶
type DomainNameList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []DomainName `json:"items"` }
DomainNameList contains a list of DomainName +kubebuilder:object:root=true
func (*DomainNameList) DeepCopy ¶
func (in *DomainNameList) DeepCopy() *DomainNameList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DomainNameList.
func (*DomainNameList) DeepCopyInto ¶
func (in *DomainNameList) DeepCopyInto(out *DomainNameList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DomainNameList) DeepCopyObject ¶
func (in *DomainNameList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DomainNameSpec ¶
type DomainNameSpec struct { // The domain name. // +kubebuilder:validation:Required DomainName *string `json:"domainName"` // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `json:"domainNameConfigurations,omitempty"` // The mutual TLS authentication configuration for a custom domain name. MutualTLSAuthentication *MutualTLSAuthenticationInput `json:"mutualTLSAuthentication,omitempty"` // The collection of tags associated with a domain name. Tags map[string]*string `json:"tags,omitempty"` }
DomainNameSpec defines the desired state of DomainName.
Represents a domain name.
func (*DomainNameSpec) DeepCopy ¶
func (in *DomainNameSpec) DeepCopy() *DomainNameSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DomainNameSpec.
func (*DomainNameSpec) DeepCopyInto ¶
func (in *DomainNameSpec) DeepCopyInto(out *DomainNameSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DomainNameStatus ¶
type DomainNameStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // The API mapping selection expression. // +kubebuilder:validation:Optional APIMappingSelectionExpression *string `json:"apiMappingSelectionExpression,omitempty"` }
DomainNameStatus defines the observed state of DomainName
func (*DomainNameStatus) DeepCopy ¶
func (in *DomainNameStatus) DeepCopy() *DomainNameStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DomainNameStatus.
func (*DomainNameStatus) DeepCopyInto ¶
func (in *DomainNameStatus) DeepCopyInto(out *DomainNameStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DomainNameStatus_SDK ¶
type DomainNameStatus_SDK string
const ( DomainNameStatus_SDK_AVAILABLE DomainNameStatus_SDK = "AVAILABLE" DomainNameStatus_SDK_PENDING_CERTIFICATE_REIMPORT DomainNameStatus_SDK = "PENDING_CERTIFICATE_REIMPORT" DomainNameStatus_SDK_PENDING_OWNERSHIP_VERIFICATION DomainNameStatus_SDK = "PENDING_OWNERSHIP_VERIFICATION" DomainNameStatus_SDK_UPDATING DomainNameStatus_SDK = "UPDATING" )
type DomainName_SDK ¶
type DomainName_SDK struct { // An expression used to extract information at runtime. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for more information. APIMappingSelectionExpression *string `json:"apiMappingSelectionExpression,omitempty"` // A string with a length between [1-512]. DomainName *string `json:"domainName,omitempty"` // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `json:"domainNameConfigurations,omitempty"` MutualTLSAuthentication *MutualTLSAuthentication `json:"mutualTLSAuthentication,omitempty"` // Represents a collection of tags associated with the resource. Tags map[string]*string `json:"tags,omitempty"` }
Represents a domain name.
func (*DomainName_SDK) DeepCopy ¶
func (in *DomainName_SDK) DeepCopy() *DomainName_SDK
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DomainName_SDK.
func (*DomainName_SDK) DeepCopyInto ¶
func (in *DomainName_SDK) DeepCopyInto(out *DomainName_SDK)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EndpointType ¶
type EndpointType string
const ( EndpointType_EDGE EndpointType = "EDGE" EndpointType_REGIONAL EndpointType = "REGIONAL" )
type Integration ¶
type Integration struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec IntegrationSpec `json:"spec,omitempty"` Status IntegrationStatus `json:"status,omitempty"` }
Integration is the Schema for the Integrations API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Integration) DeepCopy ¶
func (in *Integration) DeepCopy() *Integration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Integration.
func (*Integration) DeepCopyInto ¶
func (in *Integration) DeepCopyInto(out *Integration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Integration) DeepCopyObject ¶
func (in *Integration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type IntegrationList ¶
type IntegrationList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Integration `json:"items"` }
IntegrationList contains a list of Integration +kubebuilder:object:root=true
func (*IntegrationList) DeepCopy ¶
func (in *IntegrationList) DeepCopy() *IntegrationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntegrationList.
func (*IntegrationList) DeepCopyInto ¶
func (in *IntegrationList) DeepCopyInto(out *IntegrationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IntegrationList) DeepCopyObject ¶
func (in *IntegrationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type IntegrationResponse ¶
type IntegrationResponse struct { // Specifies how to handle response payload content type conversions. Supported // only for WebSocket APIs. ContentHandlingStrategy *string `json:"contentHandlingStrategy,omitempty"` // The identifier. IntegrationResponseID *string `json:"integrationResponseID,omitempty"` // After evaluating a selection expression, the result is compared against one // or more selection keys to find a matching key. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for a list of expressions and each expression's associated selection key // type. IntegrationResponseKey *string `json:"integrationResponseKey,omitempty"` // For WebSocket APIs, a key-value map specifying request parameters that are // passed from the method request to the backend. The key is an integration // request parameter name and the associated value is a method request parameter // value or static value that must be enclosed within single quotes and pre-encoded // as required by the backend. The method request parameter value must match // the pattern of method.request.{location}.{name} , where {location} is querystring, // path, or header; and {name} must be a valid and unique method request parameter // name. // // For HTTP API integrations with a specified integrationSubtype, request parameters // are a key-value map specifying parameters that are passed to AWS_PROXY integrations. // You can provide static values, or map request data, stage variables, or context // variables that are evaluated at runtime. To learn more, see Working with // AWS service integrations for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). // // For HTTP API integrations without a specified integrationSubtype request // parameters are a key-value map specifying how to transform HTTP requests // before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> // where action can be append, overwrite or remove. For values, you can provide // static values, or map request data, stage variables, or context variables // that are evaluated at runtime. To learn more, see Transforming API requests // and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). ResponseParameters map[string]*string `json:"responseParameters,omitempty"` // A mapping of identifier keys to templates. The value is an actual template // script. The key is typically a SelectionKey which is chosen based on evaluating // a selection expression. ResponseTemplates map[string]*string `json:"responseTemplates,omitempty"` // An expression used to extract information at runtime. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for more information. TemplateSelectionExpression *string `json:"templateSelectionExpression,omitempty"` }
Represents an integration response.
func (*IntegrationResponse) DeepCopy ¶
func (in *IntegrationResponse) DeepCopy() *IntegrationResponse
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntegrationResponse.
func (*IntegrationResponse) DeepCopyInto ¶
func (in *IntegrationResponse) DeepCopyInto(out *IntegrationResponse)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IntegrationSpec ¶
type IntegrationSpec struct { // The API identifier. APIID *string `json:"apiID,omitempty"` APIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"apiRef,omitempty"` // The ID of the VPC link for a private integration. Supported only for HTTP // APIs. ConnectionID *string `json:"connectionID,omitempty"` ConnectionRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"connectionRef,omitempty"` // The type of the network connection to the integration endpoint. Specify INTERNET // for connections through the public routable internet or VPC_LINK for private // connections between API Gateway and resources in a VPC. The default value // is INTERNET. ConnectionType *string `json:"connectionType,omitempty"` // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, // with the following behaviors: // // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string // to the corresponding binary blob. // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded // string. // // If this property is not defined, the response payload will be passed through // from the integration response to the route response or method response without // modification. ContentHandlingStrategy *string `json:"contentHandlingStrategy,omitempty"` // Specifies the credentials required for the integration, if any. For AWS integrations, // three options are available. To specify an IAM Role for API Gateway to assume, // use the role's Amazon Resource Name (ARN). To require that the caller's identity // be passed through from the request, specify the string arn:aws:iam::*:user/*. // To use resource-based permissions on supported AWS services, specify null. CredentialsARN *string `json:"credentialsARN,omitempty"` // The description of the integration. Description *string `json:"description,omitempty"` // Specifies the integration's HTTP method type. IntegrationMethod *string `json:"integrationMethod,omitempty"` // Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service // action to invoke. To learn more, see Integration subtype reference (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html). IntegrationSubtype *string `json:"integrationSubtype,omitempty"` // The integration type of an integration. One of the following: // // AWS: for integrating the route or method request with an AWS service action, // including the Lambda function-invoking action. With the Lambda function-invoking // action, this is referred to as the Lambda custom integration. With any other // AWS service action, this is known as AWS integration. Supported only for // WebSocket APIs. // // AWS_PROXY: for integrating the route or method request with a Lambda function // or other AWS service action. This integration is also referred to as a Lambda // proxy integration. // // HTTP: for integrating the route or method request with an HTTP endpoint. // This integration is also referred to as the HTTP custom integration. Supported // only for WebSocket APIs. // // HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, // with the client request passed through as-is. This is also referred to as // HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY // integration. // // MOCK: for integrating the route or method request with API Gateway as a "loopback" // endpoint without invoking any backend. Supported only for WebSocket APIs. // +kubebuilder:validation:Required IntegrationType *string `json:"integrationType"` // For a Lambda integration, specify the URI of a Lambda function. // // For an HTTP integration, specify a fully-qualified URL. // // For an HTTP API private integration, specify the ARN of an Application Load // Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. // If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances // to identify resources. You can use query parameters to target specific resources. // To learn more, see DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). // For private integrations, all resources must be owned by the same AWS account. IntegrationURI *string `json:"integrationURI,omitempty"` // Specifies the pass-through behavior for incoming requests based on the Content-Type // header in the request, and the available mapping templates specified as the // requestTemplates property on the Integration resource. There are three valid // values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket // APIs. // // WHEN_NO_MATCH passes the request body for unmapped content types through // to the integration backend without transformation. // // NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type // response. // // WHEN_NO_TEMPLATES allows pass-through when the integration has no content // types mapped to templates. However, if there is at least one content type // defined, unmapped content types will be rejected with the same HTTP 415 Unsupported // Media Type response. PassthroughBehavior *string `json:"passthroughBehavior,omitempty"` // Specifies the format of the payload sent to an integration. Required for // HTTP APIs. PayloadFormatVersion *string `json:"payloadFormatVersion,omitempty"` // For WebSocket APIs, a key-value map specifying request parameters that are // passed from the method request to the backend. The key is an integration // request parameter name and the associated value is a method request parameter // value or static value that must be enclosed within single quotes and pre-encoded // as required by the backend. The method request parameter value must match // the pattern of method.request.{location}.{name} , where {location} is querystring, // path, or header; and {name} must be a valid and unique method request parameter // name. // // For HTTP API integrations with a specified integrationSubtype, request parameters // are a key-value map specifying parameters that are passed to AWS_PROXY integrations. // You can provide static values, or map request data, stage variables, or context // variables that are evaluated at runtime. To learn more, see Working with // AWS service integrations for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). // // For HTTP API integrations without a specified integrationSubtype request // parameters are a key-value map specifying how to transform HTTP requests // before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> // where action can be append, overwrite or remove. For values, you can provide // static values, or map request data, stage variables, or context variables // that are evaluated at runtime. To learn more, see Transforming API requests // and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). RequestParameters map[string]*string `json:"requestParameters,omitempty"` // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the // value. Supported only for WebSocket APIs. RequestTemplates map[string]*string `json:"requestTemplates,omitempty"` // Supported only for HTTP APIs. You use response parameters to transform the // HTTP response from a backend integration before returning the response to // clients. Specify a key-value map from a selection key to response parameters. // The selection key must be a valid HTTP status code within the range of 200-599. // Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> // or overwrite.statuscode. The action can be append, overwrite or remove. The // value can be a static value, or map to response data, stage variables, or // context variables that are evaluated at runtime. To learn more, see Transforming // API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). ResponseParameters map[string]map[string]*string `json:"responseParameters,omitempty"` // The template selection expression for the integration. TemplateSelectionExpression *string `json:"templateSelectionExpression,omitempty"` // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and // between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is // 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis *int64 `json:"timeoutInMillis,omitempty"` // The TLS configuration for a private integration. If you specify a TLS configuration, // private integration traffic uses the HTTPS protocol. Supported only for HTTP // APIs. TLSConfig *TLSConfigInput `json:"tlsConfig,omitempty"` }
IntegrationSpec defines the desired state of Integration.
Represents an integration.
func (*IntegrationSpec) DeepCopy ¶
func (in *IntegrationSpec) DeepCopy() *IntegrationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntegrationSpec.
func (*IntegrationSpec) DeepCopyInto ¶
func (in *IntegrationSpec) DeepCopyInto(out *IntegrationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IntegrationStatus ¶
type IntegrationStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // Specifies whether an integration is managed by API Gateway. If you created // an API using using quick create, the resulting integration is managed by // API Gateway. You can update a managed integration, but you can't delete it. // +kubebuilder:validation:Optional APIGatewayManaged *bool `json:"apiGatewayManaged,omitempty"` // Represents the identifier of an integration. // +kubebuilder:validation:Optional IntegrationID *string `json:"integrationID,omitempty"` // The integration response selection expression for the integration. Supported // only for WebSocket APIs. See Integration Response Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). // +kubebuilder:validation:Optional IntegrationResponseSelectionExpression *string `json:"integrationResponseSelectionExpression,omitempty"` }
IntegrationStatus defines the observed state of Integration
func (*IntegrationStatus) DeepCopy ¶
func (in *IntegrationStatus) DeepCopy() *IntegrationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntegrationStatus.
func (*IntegrationStatus) DeepCopyInto ¶
func (in *IntegrationStatus) DeepCopyInto(out *IntegrationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IntegrationType ¶
type IntegrationType string
const ( IntegrationType_AWS IntegrationType = "AWS" IntegrationType_AWS_PROXY IntegrationType = "AWS_PROXY" IntegrationType_HTTP IntegrationType = "HTTP" IntegrationType_HTTP_PROXY IntegrationType = "HTTP_PROXY" IntegrationType_MOCK IntegrationType = "MOCK" )
type Integration_SDK ¶
type Integration_SDK struct { APIGatewayManaged *bool `json:"apiGatewayManaged,omitempty"` // A string with a length between [1-1024]. ConnectionID *string `json:"connectionID,omitempty"` // Represents a connection type. ConnectionType *string `json:"connectionType,omitempty"` // Specifies how to handle response payload content type conversions. Supported // only for WebSocket APIs. ContentHandlingStrategy *string `json:"contentHandlingStrategy,omitempty"` // Represents an Amazon Resource Name (ARN). CredentialsARN *string `json:"credentialsARN,omitempty"` // A string with a length between [0-1024]. Description *string `json:"description,omitempty"` // The identifier. IntegrationID *string `json:"integrationID,omitempty"` // A string with a length between [1-64]. IntegrationMethod *string `json:"integrationMethod,omitempty"` // An expression used to extract information at runtime. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for more information. IntegrationResponseSelectionExpression *string `json:"integrationResponseSelectionExpression,omitempty"` // A string with a length between [1-128]. IntegrationSubtype *string `json:"integrationSubtype,omitempty"` // Represents an API method integration type. IntegrationType *string `json:"integrationType,omitempty"` // A string representation of a URI with a length between [1-2048]. IntegrationURI *string `json:"integrationURI,omitempty"` // Represents passthrough behavior for an integration response. Supported only // for WebSocket APIs. PassthroughBehavior *string `json:"passthroughBehavior,omitempty"` // A string with a length between [1-64]. PayloadFormatVersion *string `json:"payloadFormatVersion,omitempty"` // For WebSocket APIs, a key-value map specifying request parameters that are // passed from the method request to the backend. The key is an integration // request parameter name and the associated value is a method request parameter // value or static value that must be enclosed within single quotes and pre-encoded // as required by the backend. The method request parameter value must match // the pattern of method.request.{location}.{name} , where {location} is querystring, // path, or header; and {name} must be a valid and unique method request parameter // name. // // For HTTP API integrations with a specified integrationSubtype, request parameters // are a key-value map specifying parameters that are passed to AWS_PROXY integrations. // You can provide static values, or map request data, stage variables, or context // variables that are evaluated at runtime. To learn more, see Working with // AWS service integrations for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). // // For HTTP API integrations without a specified integrationSubtype request // parameters are a key-value map specifying how to transform HTTP requests // before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> // where action can be append, overwrite or remove. For values, you can provide // static values, or map request data, stage variables, or context variables // that are evaluated at runtime. To learn more, see Transforming API requests // and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). RequestParameters map[string]*string `json:"requestParameters,omitempty"` // A mapping of identifier keys to templates. The value is an actual template // script. The key is typically a SelectionKey which is chosen based on evaluating // a selection expression. RequestTemplates map[string]*string `json:"requestTemplates,omitempty"` // Supported only for HTTP APIs. You use response parameters to transform the // HTTP response from a backend integration before returning the response to // clients. ResponseParameters map[string]map[string]*string `json:"responseParameters,omitempty"` // An expression used to extract information at runtime. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for more information. TemplateSelectionExpression *string `json:"templateSelectionExpression,omitempty"` // An integer with a value between [50-30000]. TimeoutInMillis *int64 `json:"timeoutInMillis,omitempty"` // The TLS configuration for a private integration. If you specify a TLS configuration, // private integration traffic uses the HTTPS protocol. Supported only for HTTP // APIs. TLSConfig *TLSConfig `json:"tlsConfig,omitempty"` }
Represents an integration.
func (*Integration_SDK) DeepCopy ¶
func (in *Integration_SDK) DeepCopy() *Integration_SDK
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Integration_SDK.
func (*Integration_SDK) DeepCopyInto ¶
func (in *Integration_SDK) DeepCopyInto(out *Integration_SDK)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JWTConfiguration ¶
type JWTConfiguration struct { Audience []*string `json:"audience,omitempty"` // A string representation of a URI with a length between [1-2048]. Issuer *string `json:"issuer,omitempty"` }
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
func (*JWTConfiguration) DeepCopy ¶
func (in *JWTConfiguration) DeepCopy() *JWTConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JWTConfiguration.
func (*JWTConfiguration) DeepCopyInto ¶
func (in *JWTConfiguration) DeepCopyInto(out *JWTConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LoggingLevel ¶
type LoggingLevel string
const ( LoggingLevel_ERROR LoggingLevel = "ERROR" LoggingLevel_INFO LoggingLevel = "INFO" LoggingLevel_OFF LoggingLevel = "OFF" )
type Model ¶
type Model struct { // A string with a length between [0-1024]. Description *string `json:"description,omitempty"` // The identifier. ModelID *string `json:"modelID,omitempty"` // A string with a length between [1-128]. Name *string `json:"name,omitempty"` // A string with a length between [0-32768]. Schema *string `json:"schema,omitempty"` }
Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html).
func (*Model) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Model.
func (*Model) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MutualTLSAuthentication ¶
type MutualTLSAuthentication struct { // A string representation of a URI with a length between [1-2048]. TruststoreURI *string `json:"truststoreURI,omitempty"` // A string with a length between [1-64]. TruststoreVersion *string `json:"truststoreVersion,omitempty"` TruststoreWarnings []*string `json:"truststoreWarnings,omitempty"` }
func (*MutualTLSAuthentication) DeepCopy ¶
func (in *MutualTLSAuthentication) DeepCopy() *MutualTLSAuthentication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MutualTLSAuthentication.
func (*MutualTLSAuthentication) DeepCopyInto ¶
func (in *MutualTLSAuthentication) DeepCopyInto(out *MutualTLSAuthentication)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MutualTLSAuthenticationInput ¶
type MutualTLSAuthenticationInput struct { // A string representation of a URI with a length between [1-2048]. TruststoreURI *string `json:"truststoreURI,omitempty"` // A string with a length between [1-64]. TruststoreVersion *string `json:"truststoreVersion,omitempty"` }
func (*MutualTLSAuthenticationInput) DeepCopy ¶
func (in *MutualTLSAuthenticationInput) DeepCopy() *MutualTLSAuthenticationInput
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MutualTLSAuthenticationInput.
func (*MutualTLSAuthenticationInput) DeepCopyInto ¶
func (in *MutualTLSAuthenticationInput) DeepCopyInto(out *MutualTLSAuthenticationInput)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ParameterConstraints ¶
type ParameterConstraints struct {
Required *bool `json:"required,omitempty"`
}
Validation constraints imposed on parameters of a request (path, query string, headers).
func (*ParameterConstraints) DeepCopy ¶
func (in *ParameterConstraints) DeepCopy() *ParameterConstraints
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ParameterConstraints.
func (*ParameterConstraints) DeepCopyInto ¶
func (in *ParameterConstraints) DeepCopyInto(out *ParameterConstraints)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PassthroughBehavior ¶
type PassthroughBehavior string
const ( PassthroughBehavior_NEVER PassthroughBehavior = "NEVER" PassthroughBehavior_WHEN_NO_MATCH PassthroughBehavior = "WHEN_NO_MATCH" PassthroughBehavior_WHEN_NO_TEMPLATES PassthroughBehavior = "WHEN_NO_TEMPLATES" )
type ProtocolType ¶
type ProtocolType string
const ( ProtocolType_HTTP ProtocolType = "HTTP" ProtocolType_WEBSOCKET ProtocolType = "WEBSOCKET" )
type Route ¶
type Route struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec RouteSpec `json:"spec,omitempty"` Status RouteStatus `json:"status,omitempty"` }
Route is the Schema for the Routes API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Route) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Route.
func (*Route) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Route) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RouteList ¶
type RouteList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Route `json:"items"` }
RouteList contains a list of Route +kubebuilder:object:root=true
func (*RouteList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteList.
func (*RouteList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RouteList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RouteResponse ¶
type RouteResponse struct { // An expression used to extract information at runtime. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for more information. ModelSelectionExpression *string `json:"modelSelectionExpression,omitempty"` // The route models. ResponseModels map[string]*string `json:"responseModels,omitempty"` // The route parameters. ResponseParameters map[string]*ParameterConstraints `json:"responseParameters,omitempty"` // The identifier. RouteResponseID *string `json:"routeResponseID,omitempty"` // After evaluating a selection expression, the result is compared against one // or more selection keys to find a matching key. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for a list of expressions and each expression's associated selection key // type. RouteResponseKey *string `json:"routeResponseKey,omitempty"` }
Represents a route response.
func (*RouteResponse) DeepCopy ¶
func (in *RouteResponse) DeepCopy() *RouteResponse
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteResponse.
func (*RouteResponse) DeepCopyInto ¶
func (in *RouteResponse) DeepCopyInto(out *RouteResponse)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouteSettings ¶
type RouteSettings struct { DataTraceEnabled *bool `json:"dataTraceEnabled,omitempty"` DetailedMetricsEnabled *bool `json:"detailedMetricsEnabled,omitempty"` // The logging level. LoggingLevel *string `json:"loggingLevel,omitempty"` ThrottlingBurstLimit *int64 `json:"throttlingBurstLimit,omitempty"` ThrottlingRateLimit *float64 `json:"throttlingRateLimit,omitempty"` }
Represents a collection of route settings.
func (*RouteSettings) DeepCopy ¶
func (in *RouteSettings) DeepCopy() *RouteSettings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteSettings.
func (*RouteSettings) DeepCopyInto ¶
func (in *RouteSettings) DeepCopyInto(out *RouteSettings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouteSpec ¶
type RouteSpec struct { // The API identifier. APIID *string `json:"apiID,omitempty"` // Specifies whether an API key is required for the route. Supported only for // WebSocket APIs. APIKeyRequired *bool `json:"apiKeyRequired,omitempty"` APIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"apiRef,omitempty"` // The authorization scopes supported by this route. AuthorizationScopes []*string `json:"authorizationScopes,omitempty"` // The authorization type for the route. For WebSocket APIs, valid values are // NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for // using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, // JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and // CUSTOM for using a Lambda authorizer. AuthorizationType *string `json:"authorizationType,omitempty"` // The identifier of the Authorizer resource to be associated with this route. // The authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerID *string `json:"authorizerID,omitempty"` AuthorizerRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"authorizerRef,omitempty"` // The model selection expression for the route. Supported only for WebSocket // APIs. ModelSelectionExpression *string `json:"modelSelectionExpression,omitempty"` // The operation name for the route. OperationName *string `json:"operationName,omitempty"` // The request models for the route. Supported only for WebSocket APIs. RequestModels map[string]*string `json:"requestModels,omitempty"` // The request parameters for the route. Supported only for WebSocket APIs. RequestParameters map[string]*ParameterConstraints `json:"requestParameters,omitempty"` // The route key for the route. // +kubebuilder:validation:Required RouteKey *string `json:"routeKey"` // The route response selection expression for the route. Supported only for // WebSocket APIs. RouteResponseSelectionExpression *string `json:"routeResponseSelectionExpression,omitempty"` // The target for the route. Target *string `json:"target,omitempty"` TargetRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"targetRef,omitempty"` }
RouteSpec defines the desired state of Route.
Represents a route.
func (*RouteSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteSpec.
func (*RouteSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouteStatus ¶
type RouteStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // Specifies whether a route is managed by API Gateway. If you created an API // using quick create, the $default route is managed by API Gateway. You can't // modify the $default route key. // +kubebuilder:validation:Optional APIGatewayManaged *bool `json:"apiGatewayManaged,omitempty"` // The route ID. // +kubebuilder:validation:Optional RouteID *string `json:"routeID,omitempty"` }
RouteStatus defines the observed state of Route
func (*RouteStatus) DeepCopy ¶
func (in *RouteStatus) DeepCopy() *RouteStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteStatus.
func (*RouteStatus) DeepCopyInto ¶
func (in *RouteStatus) DeepCopyInto(out *RouteStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Route_SDK ¶
type Route_SDK struct { APIGatewayManaged *bool `json:"apiGatewayManaged,omitempty"` APIKeyRequired *bool `json:"apiKeyRequired,omitempty"` // A list of authorization scopes configured on a route. The scopes are used // with a JWT authorizer to authorize the method invocation. The authorization // works by matching the route scopes against the scopes parsed from the access // token in the incoming request. The method invocation is authorized if any // route scope matches a claimed scope in the access token. Otherwise, the invocation // is not authorized. When the route scope is configured, the client must provide // an access token instead of an identity token for authorization purposes. AuthorizationScopes []*string `json:"authorizationScopes,omitempty"` // The authorization type. For WebSocket APIs, valid values are NONE for open // access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda // authorizer. For HTTP APIs, valid values are NONE for open access, JWT for // using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM // for using a Lambda authorizer. AuthorizationType *string `json:"authorizationType,omitempty"` // The identifier. AuthorizerID *string `json:"authorizerID,omitempty"` // An expression used to extract information at runtime. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for more information. ModelSelectionExpression *string `json:"modelSelectionExpression,omitempty"` // A string with a length between [1-64]. OperationName *string `json:"operationName,omitempty"` // The route models. RequestModels map[string]*string `json:"requestModels,omitempty"` // The route parameters. RequestParameters map[string]*ParameterConstraints `json:"requestParameters,omitempty"` // The identifier. RouteID *string `json:"routeID,omitempty"` // After evaluating a selection expression, the result is compared against one // or more selection keys to find a matching key. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for a list of expressions and each expression's associated selection key // type. RouteKey *string `json:"routeKey,omitempty"` // An expression used to extract information at runtime. See Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) // for more information. RouteResponseSelectionExpression *string `json:"routeResponseSelectionExpression,omitempty"` // A string with a length between [1-128]. Target *string `json:"target,omitempty"` }
Represents a route.
func (*Route_SDK) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Route_SDK.
func (*Route_SDK) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecurityPolicy ¶
type SecurityPolicy string
const ( SecurityPolicy_TLS_1_0 SecurityPolicy = "TLS_1_0" SecurityPolicy_TLS_1_2 SecurityPolicy = "TLS_1_2" )
type Stage ¶
type Stage struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec StageSpec `json:"spec,omitempty"` Status StageStatus `json:"status,omitempty"` }
Stage is the Schema for the Stages API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Stage) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Stage.
func (*Stage) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Stage) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type StageList ¶
type StageList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Stage `json:"items"` }
StageList contains a list of Stage +kubebuilder:object:root=true
func (*StageList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageList.
func (*StageList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StageList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type StageSpec ¶
type StageSpec struct { // Settings for logging access in this stage. AccessLogSettings *AccessLogSettings `json:"accessLogSettings,omitempty"` // The API identifier. APIID *string `json:"apiID,omitempty"` APIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"apiRef,omitempty"` // Specifies whether updates to an API automatically trigger a new deployment. // The default value is false. AutoDeploy *bool `json:"autoDeploy,omitempty"` // The identifier of a client certificate for a Stage. Supported only for WebSocket // APIs. ClientCertificateID *string `json:"clientCertificateID,omitempty"` // The default route settings for the stage. DefaultRouteSettings *RouteSettings `json:"defaultRouteSettings,omitempty"` // The deployment identifier of the API stage. DeploymentID *string `json:"deploymentID,omitempty"` DeploymentRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"deploymentRef,omitempty"` // The description for the API stage. Description *string `json:"description,omitempty"` // Route settings for the stage, by routeKey. RouteSettings map[string]*RouteSettings `json:"routeSettings,omitempty"` // The name of the stage. // +kubebuilder:validation:Required StageName *string `json:"stageName"` // A map that defines the stage variables for a Stage. Variable names can have // alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string `json:"stageVariables,omitempty"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string `json:"tags,omitempty"` }
StageSpec defines the desired state of Stage.
Represents an API stage.
func (*StageSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageSpec.
func (*StageSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StageStatus ¶
type StageStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // Specifies whether a stage is managed by API Gateway. If you created an API // using quick create, the $default stage is managed by API Gateway. You can't // modify the $default stage. // +kubebuilder:validation:Optional APIGatewayManaged *bool `json:"apiGatewayManaged,omitempty"` // The timestamp when the stage was created. // +kubebuilder:validation:Optional CreatedDate *metav1.Time `json:"createdDate,omitempty"` // Describes the status of the last deployment of a stage. Supported only for // stages with autoDeploy enabled. // +kubebuilder:validation:Optional LastDeploymentStatusMessage *string `json:"lastDeploymentStatusMessage,omitempty"` // The timestamp when the stage was last updated. // +kubebuilder:validation:Optional LastUpdatedDate *metav1.Time `json:"lastUpdatedDate,omitempty"` }
StageStatus defines the observed state of Stage
func (*StageStatus) DeepCopy ¶
func (in *StageStatus) DeepCopy() *StageStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageStatus.
func (*StageStatus) DeepCopyInto ¶
func (in *StageStatus) DeepCopyInto(out *StageStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Stage_SDK ¶
type Stage_SDK struct { // Settings for logging access in a stage. AccessLogSettings *AccessLogSettings `json:"accessLogSettings,omitempty"` APIGatewayManaged *bool `json:"apiGatewayManaged,omitempty"` AutoDeploy *bool `json:"autoDeploy,omitempty"` // The identifier. ClientCertificateID *string `json:"clientCertificateID,omitempty"` CreatedDate *metav1.Time `json:"createdDate,omitempty"` // Represents a collection of route settings. DefaultRouteSettings *RouteSettings `json:"defaultRouteSettings,omitempty"` // The identifier. DeploymentID *string `json:"deploymentID,omitempty"` // A string with a length between [0-1024]. Description *string `json:"description,omitempty"` LastDeploymentStatusMessage *string `json:"lastDeploymentStatusMessage,omitempty"` LastUpdatedDate *metav1.Time `json:"lastUpdatedDate,omitempty"` // The route settings map. RouteSettings map[string]*RouteSettings `json:"routeSettings,omitempty"` // A string with a length between [1-128]. StageName *string `json:"stageName,omitempty"` // The stage variable map. StageVariables map[string]*string `json:"stageVariables,omitempty"` // Represents a collection of tags associated with the resource. Tags map[string]*string `json:"tags,omitempty"` }
Represents an API stage.
func (*Stage_SDK) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Stage_SDK.
func (*Stage_SDK) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TLSConfig ¶
type TLSConfig struct { // A string with a length between [1-512]. ServerNameToVerify *string `json:"serverNameToVerify,omitempty"` }
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
func (*TLSConfig) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSConfig.
func (*TLSConfig) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TLSConfigInput ¶
type TLSConfigInput struct { // A string with a length between [1-512]. ServerNameToVerify *string `json:"serverNameToVerify,omitempty"` }
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
func (*TLSConfigInput) DeepCopy ¶
func (in *TLSConfigInput) DeepCopy() *TLSConfigInput
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSConfigInput.
func (*TLSConfigInput) DeepCopyInto ¶
func (in *TLSConfigInput) DeepCopyInto(out *TLSConfigInput)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VPCLink ¶
type VPCLink struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec VPCLinkSpec `json:"spec,omitempty"` Status VPCLinkStatus `json:"status,omitempty"` }
VPCLink is the Schema for the VPCLinks API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*VPCLink) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLink.
func (*VPCLink) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VPCLink) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type VPCLinkList ¶
type VPCLinkList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []VPCLink `json:"items"` }
VPCLinkList contains a list of VPCLink +kubebuilder:object:root=true
func (*VPCLinkList) DeepCopy ¶
func (in *VPCLinkList) DeepCopy() *VPCLinkList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLinkList.
func (*VPCLinkList) DeepCopyInto ¶
func (in *VPCLinkList) DeepCopyInto(out *VPCLinkList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VPCLinkList) DeepCopyObject ¶
func (in *VPCLinkList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type VPCLinkSpec ¶
type VPCLinkSpec struct { // The name of the VPC link. // +kubebuilder:validation:Required Name *string `json:"name"` // A list of security group IDs for the VPC link. SecurityGroupIDs []*string `json:"securityGroupIDs,omitempty"` // A list of subnet IDs to include in the VPC link. // +kubebuilder:validation:Required SubnetIDs []*string `json:"subnetIDs"` // A list of tags. Tags map[string]*string `json:"tags,omitempty"` }
VpcLinkSpec defines the desired state of VpcLink.
Represents a VPC link.
func (*VPCLinkSpec) DeepCopy ¶
func (in *VPCLinkSpec) DeepCopy() *VPCLinkSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLinkSpec.
func (*VPCLinkSpec) DeepCopyInto ¶
func (in *VPCLinkSpec) DeepCopyInto(out *VPCLinkSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VPCLinkStatus ¶
type VPCLinkStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // The timestamp when the VPC link was created. // +kubebuilder:validation:Optional CreatedDate *metav1.Time `json:"createdDate,omitempty"` // The ID of the VPC link. // +kubebuilder:validation:Optional VPCLinkID *string `json:"vpcLinkID,omitempty"` // The status of the VPC link. // +kubebuilder:validation:Optional VPCLinkStatus *string `json:"vpcLinkStatus,omitempty"` // A message summarizing the cause of the status of the VPC link. // +kubebuilder:validation:Optional VPCLinkStatusMessage *string `json:"vpcLinkStatusMessage,omitempty"` // The version of the VPC link. // +kubebuilder:validation:Optional VPCLinkVersion *string `json:"vpcLinkVersion,omitempty"` }
VPCLinkStatus defines the observed state of VPCLink
func (*VPCLinkStatus) DeepCopy ¶
func (in *VPCLinkStatus) DeepCopy() *VPCLinkStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLinkStatus.
func (*VPCLinkStatus) DeepCopyInto ¶
func (in *VPCLinkStatus) DeepCopyInto(out *VPCLinkStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VPCLinkStatus_SDK ¶
type VPCLinkStatus_SDK string
const ( VPCLinkStatus_SDK_AVAILABLE VPCLinkStatus_SDK = "AVAILABLE" VPCLinkStatus_SDK_DELETING VPCLinkStatus_SDK = "DELETING" VPCLinkStatus_SDK_FAILED VPCLinkStatus_SDK = "FAILED" VPCLinkStatus_SDK_INACTIVE VPCLinkStatus_SDK = "INACTIVE" VPCLinkStatus_SDK_PENDING VPCLinkStatus_SDK = "PENDING" )
type VPCLink_SDK ¶
type VPCLink_SDK struct { CreatedDate *metav1.Time `json:"createdDate,omitempty"` // A string with a length between [1-128]. Name *string `json:"name,omitempty"` // A list of security group IDs for the VPC link. SecurityGroupIDs []*string `json:"securityGroupIDs,omitempty"` // A list of subnet IDs to include in the VPC link. SubnetIDs []*string `json:"subnetIDs,omitempty"` // Represents a collection of tags associated with the resource. Tags map[string]*string `json:"tags,omitempty"` // The identifier. VPCLinkID *string `json:"vpcLinkID,omitempty"` // The status of the VPC link. VPCLinkStatus *string `json:"vpcLinkStatus,omitempty"` // A string with a length between [0-1024]. VPCLinkStatusMessage *string `json:"vpcLinkStatusMessage,omitempty"` // The version of the VPC link. VPCLinkVersion *string `json:"vpcLinkVersion,omitempty"` }
Represents a VPC link.
func (*VPCLink_SDK) DeepCopy ¶
func (in *VPCLink_SDK) DeepCopy() *VPCLink_SDK
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLink_SDK.
func (*VPCLink_SDK) DeepCopyInto ¶
func (in *VPCLink_SDK) DeepCopyInto(out *VPCLink_SDK)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.