v1alpha1

package
v1.0.5 Latest Latest
Warning

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

 Go to latest Published: Feb 20, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the apigateway.services.k8s.aws API. +groupName=apigateway.services.k8s.aws

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is the API Group Version used to register the objects
	GroupVersion = schema.GroupVersion{Group: "apigateway.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 APIKeySourceType 

type APIKeySourceType string
const (
	APIKeySourceType_AUTHORIZER APIKeySourceType = "AUTHORIZER"
	APIKeySourceType_HEADER     APIKeySourceType = "HEADER"
)

type APIKeysFormat 

type APIKeysFormat string
const (
	APIKeysFormat_csv APIKeysFormat = "csv"
)

type APIStage 

type APIStage struct {
	APIID *string `json:"apiID,omitempty"`
	Stage *string `json:"stage,omitempty"`
}

API stage name of the associated API stage in a usage plan.

func (*APIStage) DeepCopy 

func (in *APIStage) DeepCopy() *APIStage

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIStage.

func (*APIStage) DeepCopyInto 

func (in *APIStage) DeepCopyInto(out *APIStage)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AccessAssociationSourceType added in v1.0.3 

type AccessAssociationSourceType string
const (
	AccessAssociationSourceType_VPCE AccessAssociationSourceType = "VPCE"
)

type AccessLogSettings 

type AccessLogSettings struct {
	DestinationARN *string `json:"destinationARN,omitempty"`
	Format         *string `json:"format,omitempty"`
}

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

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 AuthorizerType 

type AuthorizerType string
const (
	AuthorizerType_COGNITO_USER_POOLS AuthorizerType = "COGNITO_USER_POOLS"
	AuthorizerType_REQUEST            AuthorizerType = "REQUEST"
	AuthorizerType_TOKEN              AuthorizerType = "TOKEN"
)

type CacheClusterSize 

type CacheClusterSize string
const (
	CacheClusterSize_0_5  CacheClusterSize = "0.5"
	CacheClusterSize_1_6  CacheClusterSize = "1.6"
	CacheClusterSize_118  CacheClusterSize = "118"
	CacheClusterSize_13_5 CacheClusterSize = "13.5"
	CacheClusterSize_237  CacheClusterSize = "237"
	CacheClusterSize_28_4 CacheClusterSize = "28.4"
	CacheClusterSize_58_2 CacheClusterSize = "58.2"
	CacheClusterSize_6_1  CacheClusterSize = "6.1"
)

type CacheClusterStatus 

type CacheClusterStatus string
const (
	CacheClusterStatus_AVAILABLE          CacheClusterStatus = "AVAILABLE"
	CacheClusterStatus_CREATE_IN_PROGRESS CacheClusterStatus = "CREATE_IN_PROGRESS"
	CacheClusterStatus_DELETE_IN_PROGRESS CacheClusterStatus = "DELETE_IN_PROGRESS"
	CacheClusterStatus_FLUSH_IN_PROGRESS  CacheClusterStatus = "FLUSH_IN_PROGRESS"
	CacheClusterStatus_NOT_AVAILABLE      CacheClusterStatus = "NOT_AVAILABLE"
)

type CanarySettings 

type CanarySettings struct {
	DeploymentID           *string            `json:"deploymentID,omitempty"`
	PercentTraffic         *float64           `json:"percentTraffic,omitempty"`
	StageVariableOverrides map[string]*string `json:"stageVariableOverrides,omitempty"`
	UseStageCache          *bool              `json:"useStageCache,omitempty"`
}

Configuration settings of a canary deployment.

func (*CanarySettings) DeepCopy 

func (in *CanarySettings) DeepCopy() *CanarySettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CanarySettings.

func (*CanarySettings) DeepCopyInto 

func (in *CanarySettings) DeepCopyInto(out *CanarySettings)

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 DeploymentCanarySettings 

type DeploymentCanarySettings struct {
	PercentTraffic         *float64           `json:"percentTraffic,omitempty"`
	StageVariableOverrides map[string]*string `json:"stageVariableOverrides,omitempty"`
	UseStageCache          *bool              `json:"useStageCache,omitempty"`
}

The input configuration for a canary deployment.

func (*DeploymentCanarySettings) DeepCopy 

func (in *DeploymentCanarySettings) DeepCopy() *DeploymentCanarySettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentCanarySettings.

func (*DeploymentCanarySettings) DeepCopyInto 

func (in *DeploymentCanarySettings) DeepCopyInto(out *DeploymentCanarySettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DocumentationPartLocation 

type DocumentationPartLocation struct {
	Method *string `json:"method,omitempty"`
	Name   *string `json:"name,omitempty"`
	Path   *string `json:"path,omitempty"`
}

Specifies the target API entity to which the documentation applies.

func (*DocumentationPartLocation) DeepCopy 

func (in *DocumentationPartLocation) DeepCopy() *DocumentationPartLocation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DocumentationPartLocation.

func (*DocumentationPartLocation) DeepCopyInto 

func (in *DocumentationPartLocation) DeepCopyInto(out *DocumentationPartLocation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DocumentationPartType 

type DocumentationPartType string
const (
	DocumentationPartType_API             DocumentationPartType = "API"
	DocumentationPartType_AUTHORIZER      DocumentationPartType = "AUTHORIZER"
	DocumentationPartType_METHOD          DocumentationPartType = "METHOD"
	DocumentationPartType_MODEL           DocumentationPartType = "MODEL"
	DocumentationPartType_PATH_PARAMETER  DocumentationPartType = "PATH_PARAMETER"
	DocumentationPartType_QUERY_PARAMETER DocumentationPartType = "QUERY_PARAMETER"
	DocumentationPartType_REQUEST_BODY    DocumentationPartType = "REQUEST_BODY"
	DocumentationPartType_REQUEST_HEADER  DocumentationPartType = "REQUEST_HEADER"
	DocumentationPartType_RESOURCE        DocumentationPartType = "RESOURCE"
	DocumentationPartType_RESPONSE        DocumentationPartType = "RESPONSE"
	DocumentationPartType_RESPONSE_BODY   DocumentationPartType = "RESPONSE_BODY"
	DocumentationPartType_RESPONSE_HEADER DocumentationPartType = "RESPONSE_HEADER"
)

type DomainNameAccessAssociation added in v1.0.3 

type DomainNameAccessAssociation struct {
	AccessAssociationSource        *string            `json:"accessAssociationSource,omitempty"`
	DomainNameAccessAssociationARN *string            `json:"domainNameAccessAssociationARN,omitempty"`
	DomainNameARN                  *string            `json:"domainNameARN,omitempty"`
	Tags                           map[string]*string `json:"tags,omitempty"`
}

Represents a domain name access association between an access association source and a private custom domain name. With a domain name access association, an access association source can invoke a private custom domain name while isolated from the public internet.

func (*DomainNameAccessAssociation) DeepCopy added in v1.0.3 

func (in *DomainNameAccessAssociation) DeepCopy() *DomainNameAccessAssociation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DomainNameAccessAssociation.

func (*DomainNameAccessAssociation) DeepCopyInto added in v1.0.3 

func (in *DomainNameAccessAssociation) DeepCopyInto(out *DomainNameAccessAssociation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DomainNameStatus 

type DomainNameStatus string
const (
	DomainNameStatus_AVAILABLE                      DomainNameStatus = "AVAILABLE"
	DomainNameStatus_PENDING                        DomainNameStatus = "PENDING"
	DomainNameStatus_PENDING_CERTIFICATE_REIMPORT   DomainNameStatus = "PENDING_CERTIFICATE_REIMPORT"
	DomainNameStatus_PENDING_OWNERSHIP_VERIFICATION DomainNameStatus = "PENDING_OWNERSHIP_VERIFICATION"
	DomainNameStatus_UPDATING                       DomainNameStatus = "UPDATING"
)

type EndpointConfiguration 

type EndpointConfiguration struct {
	Types          []*string `json:"types,omitempty"`
	VPCEndpointIDs []*string `json:"vpcEndpointIDs,omitempty"`
	// Reference field for VPCEndpointIDs
	VPCEndpointRefs []*ackv1alpha1.AWSResourceReferenceWrapper `json:"vpcEndpointRefs,omitempty"`
}

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

func (*EndpointConfiguration) DeepCopy 

func (in *EndpointConfiguration) DeepCopy() *EndpointConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointConfiguration.

func (*EndpointConfiguration) DeepCopyInto 

func (in *EndpointConfiguration) DeepCopyInto(out *EndpointConfiguration)

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_PRIVATE  EndpointType = "PRIVATE"
	EndpointType_REGIONAL EndpointType = "REGIONAL"
)

type GatewayResponseType 

type GatewayResponseType string
const (
	GatewayResponseType_ACCESS_DENIED                  GatewayResponseType = "ACCESS_DENIED"
	GatewayResponseType_API_CONFIGURATION_ERROR        GatewayResponseType = "API_CONFIGURATION_ERROR"
	GatewayResponseType_AUTHORIZER_CONFIGURATION_ERROR GatewayResponseType = "AUTHORIZER_CONFIGURATION_ERROR"
	GatewayResponseType_AUTHORIZER_FAILURE             GatewayResponseType = "AUTHORIZER_FAILURE"
	GatewayResponseType_BAD_REQUEST_BODY               GatewayResponseType = "BAD_REQUEST_BODY"
	GatewayResponseType_BAD_REQUEST_PARAMETERS         GatewayResponseType = "BAD_REQUEST_PARAMETERS"
	GatewayResponseType_DEFAULT_4XX                    GatewayResponseType = "DEFAULT_4XX"
	GatewayResponseType_DEFAULT_5XX                    GatewayResponseType = "DEFAULT_5XX"
	GatewayResponseType_EXPIRED_TOKEN                  GatewayResponseType = "EXPIRED_TOKEN"
	GatewayResponseType_INTEGRATION_FAILURE            GatewayResponseType = "INTEGRATION_FAILURE"
	GatewayResponseType_INTEGRATION_TIMEOUT            GatewayResponseType = "INTEGRATION_TIMEOUT"
	GatewayResponseType_INVALID_API_KEY                GatewayResponseType = "INVALID_API_KEY"
	GatewayResponseType_INVALID_SIGNATURE              GatewayResponseType = "INVALID_SIGNATURE"
	GatewayResponseType_MISSING_AUTHENTICATION_TOKEN   GatewayResponseType = "MISSING_AUTHENTICATION_TOKEN"
	GatewayResponseType_QUOTA_EXCEEDED                 GatewayResponseType = "QUOTA_EXCEEDED"
	GatewayResponseType_REQUEST_TOO_LARGE              GatewayResponseType = "REQUEST_TOO_LARGE"
	GatewayResponseType_RESOURCE_NOT_FOUND             GatewayResponseType = "RESOURCE_NOT_FOUND"
	GatewayResponseType_THROTTLED                      GatewayResponseType = "THROTTLED"
	GatewayResponseType_UNAUTHORIZED                   GatewayResponseType = "UNAUTHORIZED"
	GatewayResponseType_UNSUPPORTED_MEDIA_TYPE         GatewayResponseType = "UNSUPPORTED_MEDIA_TYPE"
	GatewayResponseType_WAF_FILTERED                   GatewayResponseType = "WAF_FILTERED"
)

type Integration added in v0.0.2 

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 added in v0.0.2 

func (in *Integration) DeepCopy() *Integration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Integration.

func (*Integration) DeepCopyInto added in v0.0.2 

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 added in v0.0.2 

func (in *Integration) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type IntegrationList added in v0.0.2 

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 added in v0.0.2 

func (in *IntegrationList) DeepCopy() *IntegrationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntegrationList.

func (*IntegrationList) DeepCopyInto added in v0.0.2 

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 added in v0.0.2 

func (in *IntegrationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type IntegrationResponse added in v0.0.2 

type IntegrationResponse struct {
	ContentHandling    *string            `json:"contentHandling,omitempty"`
	ResponseParameters map[string]*string `json:"responseParameters,omitempty"`
	ResponseTemplates  map[string]*string `json:"responseTemplates,omitempty"`
	SelectionPattern   *string            `json:"selectionPattern,omitempty"`
	// The status code.
	StatusCode *string `json:"statusCode,omitempty"`
}

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

func (*IntegrationResponse) DeepCopy added in v0.0.2 

func (in *IntegrationResponse) DeepCopy() *IntegrationResponse

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntegrationResponse.

func (*IntegrationResponse) DeepCopyInto added in v0.0.2 

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 added in v0.0.2 

type IntegrationSpec struct {

	// A list of request parameters whose values API Gateway caches. To be valid
	// values for cacheKeyParameters, these parameters must also be specified for
	// Method requestParameters.
	CacheKeyParameters []*string `json:"cacheKeyParameters,omitempty"`
	// Specifies a group of related cached parameters. By default, API Gateway uses
	// the resource ID as the cacheNamespace. You can specify the same cacheNamespace
	// across resources to return the same cached data for requests to different
	// resources.
	CacheNamespace *string `json:"cacheNamespace,omitempty"`
	// The ID of the VpcLink used for the integration. Specify this value only if
	// you specify VPC_LINK as the connection type.
	ConnectionID  *string                                  `json:"connectionID,omitempty"`
	ConnectionRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"connectionRef,omitempty"`
	// The type of the network connection to the integration endpoint. The valid
	// value is INTERNET for connections through the public routable internet or
	// VPC_LINK for private connections between API Gateway and a network load balancer
	// in a VPC. The default value is INTERNET.
	ConnectionType *string `json:"connectionType,omitempty"`
	// Specifies how to handle request payload content type conversions. Supported
	// values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
	//
	// If this property is not defined, the request payload will be passed through
	// from the method request to integration request without modification, provided
	// that the passthroughBehavior is configured to support payload pass-through.
	ContentHandling *string `json:"contentHandling,omitempty"`
	// Specifies whether credentials are required for a put integration.
	Credentials *string `json:"credentials,omitempty"`
	// Specifies the HTTP method for the integration.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	// +kubebuilder:validation:Required
	HTTPMethod *string `json:"httpMethod"`
	// The HTTP method for the integration.
	IntegrationHTTPMethod *string `json:"integrationHTTPMethod,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.
	PassthroughBehavior *string `json:"passthroughBehavior,omitempty"`
	// A key-value map specifying request parameters that are passed from the method
	// request to the back end. The key is an integration request parameter name
	// and the associated value is a method request parameter value or static value
	// that must be enclosed within single quotes and pre-encoded as required by
	// the back end. The method request parameter value must match the pattern of
	// method.request.{location}.{name}, where location is querystring, path, or
	// header and name must be a valid and unique method request parameter name.
	RequestParameters map[string]*string `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.
	RequestTemplates map[string]*string `json:"requestTemplates,omitempty"`
	// Specifies a put integration request's resource ID.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	ResourceID  *string                                  `json:"resourceID,omitempty"`
	ResourceRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"resourceRef,omitempty"`
	// The string identifier of the associated RestApi.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	RestAPIID  *string                                  `json:"restAPIID,omitempty"`
	RestAPIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"restAPIRef,omitempty"`
	// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000
	// milliseconds or 29 seconds.
	TimeoutInMillis *int64     `json:"timeoutInMillis,omitempty"`
	TLSConfig       *TLSConfig `json:"tlsConfig,omitempty"`
	// Specifies a put integration input's type.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	// +kubebuilder:validation:Required
	Type *string `json:"type,omitempty"`
	// Specifies Uniform Resource Identifier (URI) of the integration endpoint.
	// For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded
	// HTTP(S) URL according to the RFC-3986 specification, for either standard
	// integration, where connectionType is not VPC_LINK, or private integration,
	// where connectionType is VPC_LINK. For a private HTTP integration, the URI
	// is not used for routing. For AWS or AWS_PROXY integrations, the URI is of
	// the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}.
	// Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is
	// the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain}
	// is a designated subdomain supported by certain Amazon Web Services service
	// for fast host-name lookup. action can be used for an Amazon Web Services
	// service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query
	// string. The ensuing {service_api} refers to a supported action {name} plus
	// any required input parameters. Alternatively, path can be used for an Amazon
	// Web Services service path-based API. The ensuing service_api refers to the
	// path to an Amazon Web Services service resource, including the region of
	// the integrated Amazon Web Services service, if applicable. For example, for
	// integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
	// or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.
	URI *string `json:"uri,omitempty"`
}

IntegrationSpec defines the desired state of Integration.

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

func (*IntegrationSpec) DeepCopy added in v0.0.2 

func (in *IntegrationSpec) DeepCopy() *IntegrationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntegrationSpec.

func (*IntegrationSpec) DeepCopyInto added in v0.0.2 

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 added in v0.0.2 

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 the integration's responses.
	// +kubebuilder:validation:Optional
	IntegrationResponses map[string]*IntegrationResponse `json:"integrationResponses,omitempty"`
}

IntegrationStatus defines the observed state of Integration

func (*IntegrationStatus) DeepCopy added in v0.0.2 

func (in *IntegrationStatus) DeepCopy() *IntegrationStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntegrationStatus.

func (*IntegrationStatus) DeepCopyInto added in v0.0.2 

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 added in v1.0.3 

type Integration_SDK struct {
	CacheKeyParameters   []*string                       `json:"cacheKeyParameters,omitempty"`
	CacheNamespace       *string                         `json:"cacheNamespace,omitempty"`
	ConnectionID         *string                         `json:"connectionID,omitempty"`
	ConnectionType       *string                         `json:"connectionType,omitempty"`
	ContentHandling      *string                         `json:"contentHandling,omitempty"`
	Credentials          *string                         `json:"credentials,omitempty"`
	HTTPMethod           *string                         `json:"httpMethod,omitempty"`
	IntegrationResponses map[string]*IntegrationResponse `json:"integrationResponses,omitempty"`
	PassthroughBehavior  *string                         `json:"passthroughBehavior,omitempty"`
	RequestParameters    map[string]*string              `json:"requestParameters,omitempty"`
	RequestTemplates     map[string]*string              `json:"requestTemplates,omitempty"`
	TimeoutInMillis      *int64                          `json:"timeoutInMillis,omitempty"`
	// Specifies the TLS configuration for an integration.
	TLSConfig *TLSConfig `json:"tlsConfig,omitempty"`
	// The integration type. The valid value is HTTP for integrating an API method
	// with an HTTP backend; AWS with any Amazon Web Services service endpoints;
	// MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating
	// with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda
	// proxy integration.
	Type *string `json:"type_,omitempty"`
	URI  *string `json:"uri,omitempty"`
}

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

func (*Integration_SDK) DeepCopy added in v1.0.3 

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 added in v1.0.3 

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 LocationStatusType 

type LocationStatusType string
const (
	LocationStatusType_DOCUMENTED   LocationStatusType = "DOCUMENTED"
	LocationStatusType_UNDOCUMENTED LocationStatusType = "UNDOCUMENTED"
)

type Method added in v1.0.3 

type Method struct {
	APIKeyRequired      *bool     `json:"apiKeyRequired,omitempty"`
	AuthorizationScopes []*string `json:"authorizationScopes,omitempty"`
	AuthorizationType   *string   `json:"authorizationType,omitempty"`
	AuthorizerID        *string   `json:"authorizerID,omitempty"`
	HTTPMethod          *string   `json:"httpMethod,omitempty"`
	// Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
	MethodIntegration  *Integration_SDK           `json:"methodIntegration,omitempty"`
	MethodResponses    map[string]*MethodResponse `json:"methodResponses,omitempty"`
	OperationName      *string                    `json:"operationName,omitempty"`
	RequestModels      map[string]*string         `json:"requestModels,omitempty"`
	RequestParameters  map[string]*bool           `json:"requestParameters,omitempty"`
	RequestValidatorID *string                    `json:"requestValidatorID,omitempty"`
}

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

func (*Method) DeepCopy added in v1.0.3 

func (in *Method) DeepCopy() *Method

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Method.

func (*Method) DeepCopyInto added in v1.0.3 

func (in *Method) DeepCopyInto(out *Method)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MethodResponse added in v1.0.3 

type MethodResponse struct {
	ResponseModels     map[string]*string `json:"responseModels,omitempty"`
	ResponseParameters map[string]*bool   `json:"responseParameters,omitempty"`
	// The status code.
	StatusCode *string `json:"statusCode,omitempty"`
}

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

func (*MethodResponse) DeepCopy added in v1.0.3 

func (in *MethodResponse) DeepCopy() *MethodResponse

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MethodResponse.

func (*MethodResponse) DeepCopyInto added in v1.0.3 

func (in *MethodResponse) DeepCopyInto(out *MethodResponse)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MethodSetting 

type MethodSetting struct {
	CacheDataEncrypted                     *bool    `json:"cacheDataEncrypted,omitempty"`
	CacheTTLInSeconds                      *int64   `json:"cacheTTLInSeconds,omitempty"`
	CachingEnabled                         *bool    `json:"cachingEnabled,omitempty"`
	DataTraceEnabled                       *bool    `json:"dataTraceEnabled,omitempty"`
	LoggingLevel                           *string  `json:"loggingLevel,omitempty"`
	MetricsEnabled                         *bool    `json:"metricsEnabled,omitempty"`
	RequireAuthorizationForCacheControl    *bool    `json:"requireAuthorizationForCacheControl,omitempty"`
	ThrottlingBurstLimit                   *int64   `json:"throttlingBurstLimit,omitempty"`
	ThrottlingRateLimit                    *float64 `json:"throttlingRateLimit,omitempty"`
	UnauthorizedCacheControlHeaderStrategy *string  `json:"unauthorizedCacheControlHeaderStrategy,omitempty"`
}

Specifies the method setting properties.

func (*MethodSetting) DeepCopy 

func (in *MethodSetting) DeepCopy() *MethodSetting

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MethodSetting.

func (*MethodSetting) DeepCopyInto 

func (in *MethodSetting) DeepCopyInto(out *MethodSetting)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MethodSnapshot 

type MethodSnapshot struct {
	APIKeyRequired    *bool   `json:"apiKeyRequired,omitempty"`
	AuthorizationType *string `json:"authorizationType,omitempty"`
}

Represents a summary of a Method resource, given a particular date and time.

func (*MethodSnapshot) DeepCopy 

func (in *MethodSnapshot) DeepCopy() *MethodSnapshot

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MethodSnapshot.

func (*MethodSnapshot) DeepCopyInto 

func (in *MethodSnapshot) DeepCopyInto(out *MethodSnapshot)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MutualTLSAuthentication 

type MutualTLSAuthentication struct {
	TruststoreURI      *string   `json:"truststoreURI,omitempty"`
	TruststoreVersion  *string   `json:"truststoreVersion,omitempty"`
	TruststoreWarnings []*string `json:"truststoreWarnings,omitempty"`
}

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

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 {
	TruststoreURI     *string `json:"truststoreURI,omitempty"`
	TruststoreVersion *string `json:"truststoreVersion,omitempty"`
}

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

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 Op 

type Op string
const (
	Op_add     Op = "add"
	Op_copy    Op = "copy"
	Op_move    Op = "move"
	Op_remove  Op = "remove"
	Op_replace Op = "replace"
	Op_test    Op = "test"
)

type PatchOperation 

type PatchOperation struct {
	From  *string `json:"from,omitempty"`
	Op    *string `json:"op,omitempty"`
	Path  *string `json:"path,omitempty"`
	Value *string `json:"value,omitempty"`
}

For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html).

func (*PatchOperation) DeepCopy 

func (in *PatchOperation) DeepCopy() *PatchOperation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PatchOperation.

func (*PatchOperation) DeepCopyInto 

func (in *PatchOperation) DeepCopyInto(out *PatchOperation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PutMode 

type PutMode string
const (
	PutMode_merge     PutMode = "merge"
	PutMode_overwrite PutMode = "overwrite"
)

type QuotaPeriodType 

type QuotaPeriodType string
const (
	QuotaPeriodType_DAY   QuotaPeriodType = "DAY"
	QuotaPeriodType_MONTH QuotaPeriodType = "MONTH"
	QuotaPeriodType_WEEK  QuotaPeriodType = "WEEK"
)

type QuotaSettings added in v0.0.2 

type QuotaSettings struct {
	Limit  *int64 `json:"limit,omitempty"`
	Offset *int64 `json:"offset,omitempty"`
}

Quotas configured for a usage plan.

func (*QuotaSettings) DeepCopy added in v0.0.2 

func (in *QuotaSettings) DeepCopy() *QuotaSettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new QuotaSettings.

func (*QuotaSettings) DeepCopyInto added in v0.0.2 

func (in *QuotaSettings) DeepCopyInto(out *QuotaSettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Resource added in v0.0.2 

type Resource struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              ResourceSpec   `json:"spec,omitempty"`
	Status            ResourceStatus `json:"status,omitempty"`
}

Resource is the Schema for the Resources API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*Resource) DeepCopy added in v0.0.2 

func (in *Resource) DeepCopy() *Resource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.

func (*Resource) DeepCopyInto added in v0.0.2 

func (in *Resource) DeepCopyInto(out *Resource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Resource) DeepCopyObject added in v0.0.2 

func (in *Resource) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceList added in v0.0.2 

type ResourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Resource `json:"items"`
}

ResourceList contains a list of Resource +kubebuilder:object:root=true

func (*ResourceList) DeepCopy added in v0.0.2 

func (in *ResourceList) DeepCopy() *ResourceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceList.

func (*ResourceList) DeepCopyInto added in v0.0.2 

func (in *ResourceList) DeepCopyInto(out *ResourceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceList) DeepCopyObject added in v0.0.2 

func (in *ResourceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceOwner added in v1.0.3 

type ResourceOwner string
const (
	ResourceOwner_OTHER_ACCOUNTS ResourceOwner = "OTHER_ACCOUNTS"
	ResourceOwner_SELF           ResourceOwner = "SELF"
)

type ResourceSpec added in v0.0.2 

type ResourceSpec struct {

	// The parent resource's identifier.
	ParentID  *string                                  `json:"parentID,omitempty"`
	ParentRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"parentRef,omitempty"`
	// The last path segment for this resource.
	// +kubebuilder:validation:Required
	PathPart *string `json:"pathPart"`
	// The string identifier of the associated RestApi.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	RestAPIID  *string                                  `json:"restAPIID,omitempty"`
	RestAPIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"restAPIRef,omitempty"`
}

ResourceSpec defines the desired state of Resource.

Represents an API resource.

func (*ResourceSpec) DeepCopy added in v0.0.2 

func (in *ResourceSpec) DeepCopy() *ResourceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceSpec.

func (*ResourceSpec) DeepCopyInto added in v0.0.2 

func (in *ResourceSpec) DeepCopyInto(out *ResourceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceStatus added in v0.0.2 

type ResourceStatus 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 resource's identifier.
	// +kubebuilder:validation:Optional
	ID *string `json:"id,omitempty"`
	// The full path for this resource.
	// +kubebuilder:validation:Optional
	Path *string `json:"path,omitempty"`
}

ResourceStatus defines the observed state of Resource

func (*ResourceStatus) DeepCopy added in v0.0.2 

func (in *ResourceStatus) DeepCopy() *ResourceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceStatus.

func (*ResourceStatus) DeepCopyInto added in v0.0.2 

func (in *ResourceStatus) DeepCopyInto(out *ResourceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Resource_SDK added in v0.0.2 

type Resource_SDK struct {
	ID       *string `json:"id,omitempty"`
	ParentID *string `json:"parentID,omitempty"`
	Path     *string `json:"path,omitempty"`
	PathPart *string `json:"pathPart,omitempty"`
}

Represents an API resource.

func (*Resource_SDK) DeepCopy added in v0.0.2 

func (in *Resource_SDK) DeepCopy() *Resource_SDK

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource_SDK.

func (*Resource_SDK) DeepCopyInto added in v0.0.2 

func (in *Resource_SDK) DeepCopyInto(out *Resource_SDK)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RestAPI 

type RestAPI struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              RestAPISpec   `json:"spec,omitempty"`
	Status            RestAPIStatus `json:"status,omitempty"`
}

RestAPI is the Schema for the RestAPIS API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*RestAPI) DeepCopy 

func (in *RestAPI) DeepCopy() *RestAPI

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestAPI.

func (*RestAPI) DeepCopyInto 

func (in *RestAPI) DeepCopyInto(out *RestAPI)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RestAPI) DeepCopyObject 

func (in *RestAPI) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RestAPIList 

type RestAPIList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []RestAPI `json:"items"`
}

RestAPIList contains a list of RestAPI +kubebuilder:object:root=true

func (*RestAPIList) DeepCopy 

func (in *RestAPIList) DeepCopy() *RestAPIList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestAPIList.

func (*RestAPIList) DeepCopyInto 

func (in *RestAPIList) DeepCopyInto(out *RestAPIList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RestAPIList) DeepCopyObject 

func (in *RestAPIList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RestAPISpec 

type RestAPISpec struct {

	// The source of the API key for metering requests according to a usage plan.
	// Valid values are: HEADER to read the API key from the X-API-Key header of
	// a request. AUTHORIZER to read the API key from the UsageIdentifierKey from
	// a custom authorizer.
	APIKeySource *string `json:"apiKeySource,omitempty"`
	// The list of binary media types supported by the RestApi. By default, the
	// RestApi supports only UTF-8-encoded text payloads.
	BinaryMediaTypes []*string `json:"binaryMediaTypes,omitempty"`
	// The ID of the RestApi that you want to clone from.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	CloneFrom *string `json:"cloneFrom,omitempty"`
	// The description of the RestApi.
	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"`
	// The endpoint configuration of this RestApi showing the endpoint types of
	// the API.
	EndpointConfiguration *EndpointConfiguration `json:"endpointConfiguration,omitempty"`
	// A nullable integer that is used to enable compression (with non-negative
	// between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with
	// a null value) on an API. When compression is enabled, compression or decompression
	// is not applied on the payload if the payload size is smaller than this value.
	// Setting it to zero allows compression for any payload size.
	MinimumCompressionSize *int64 `json:"minimumCompressionSize,omitempty"`
	// The name of the RestApi.
	// +kubebuilder:validation:Required
	Name *string `json:"name"`
	// A stringified JSON policy document that applies to this RestApi regardless
	// of the caller and Method configuration.
	Policy *string `json:"policy,omitempty"`
	// The key-value map of strings. The valid character set is [a-zA-Z+-=._:/].
	// The tag key can be up to 128 characters and must not start with aws:. The
	// tag value can be up to 256 characters.
	Tags map[string]*string `json:"tags,omitempty"`
	// A version identifier for the API.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	Version *string `json:"version,omitempty"`
}

RestApiSpec defines the desired state of RestApi.

Represents a REST API.

func (*RestAPISpec) DeepCopy 

func (in *RestAPISpec) DeepCopy() *RestAPISpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestAPISpec.

func (*RestAPISpec) DeepCopyInto 

func (in *RestAPISpec) DeepCopyInto(out *RestAPISpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RestAPIStatus 

type RestAPIStatus 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 API was created.
	// +kubebuilder:validation:Optional
	CreatedDate *metav1.Time `json:"createdDate,omitempty"`
	// The API's identifier. This identifier is unique across all of your APIs in
	// API Gateway.
	// +kubebuilder:validation:Optional
	ID *string `json:"id,omitempty"`
	// The API's root resource ID.
	// +kubebuilder:validation:Optional
	RootResourceID *string `json:"rootResourceID,omitempty"`
	// The warning messages reported when failonwarnings is turned on during API
	// import.
	// +kubebuilder:validation:Optional
	Warnings []*string `json:"warnings,omitempty"`
}

RestAPIStatus defines the observed state of RestAPI

func (*RestAPIStatus) DeepCopy 

func (in *RestAPIStatus) DeepCopy() *RestAPIStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestAPIStatus.

func (*RestAPIStatus) DeepCopyInto 

func (in *RestAPIStatus) DeepCopyInto(out *RestAPIStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RestAPI_SDK 

type RestAPI_SDK struct {
	APIKeySource              *string      `json:"apiKeySource,omitempty"`
	BinaryMediaTypes          []*string    `json:"binaryMediaTypes,omitempty"`
	CreatedDate               *metav1.Time `json:"createdDate,omitempty"`
	Description               *string      `json:"description,omitempty"`
	DisableExecuteAPIEndpoint *bool        `json:"disableExecuteAPIEndpoint,omitempty"`
	// The endpoint configuration to indicate the types of endpoints an API (RestApi)
	// or its custom domain name (DomainName) has.
	EndpointConfiguration  *EndpointConfiguration `json:"endpointConfiguration,omitempty"`
	ID                     *string                `json:"id,omitempty"`
	MinimumCompressionSize *int64                 `json:"minimumCompressionSize,omitempty"`
	Name                   *string                `json:"name,omitempty"`
	Policy                 *string                `json:"policy,omitempty"`
	RootResourceID         *string                `json:"rootResourceID,omitempty"`
	Tags                   map[string]*string     `json:"tags,omitempty"`
	Version                *string                `json:"version,omitempty"`
	Warnings               []*string              `json:"warnings,omitempty"`
}

Represents a REST API.

func (*RestAPI_SDK) DeepCopy 

func (in *RestAPI_SDK) DeepCopy() *RestAPI_SDK

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestAPI_SDK.

func (*RestAPI_SDK) DeepCopyInto 

func (in *RestAPI_SDK) DeepCopyInto(out *RestAPI_SDK)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SDKConfigurationProperty 

type SDKConfigurationProperty struct {
	DefaultValue *string `json:"defaultValue,omitempty"`
	Description  *string `json:"description,omitempty"`
	FriendlyName *string `json:"friendlyName,omitempty"`
	Name         *string `json:"name,omitempty"`
	Required     *bool   `json:"required,omitempty"`
}

A configuration property of an SDK type.

func (*SDKConfigurationProperty) DeepCopy 

func (in *SDKConfigurationProperty) DeepCopy() *SDKConfigurationProperty

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SDKConfigurationProperty.

func (*SDKConfigurationProperty) DeepCopyInto 

func (in *SDKConfigurationProperty) DeepCopyInto(out *SDKConfigurationProperty)

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 added in v0.0.2 

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 added in v0.0.2 

func (in *Stage) DeepCopy() *Stage

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Stage.

func (*Stage) DeepCopyInto added in v0.0.2 

func (in *Stage) DeepCopyInto(out *Stage)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Stage) DeepCopyObject added in v0.0.2 

func (in *Stage) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StageKey 

type StageKey struct {
	RestAPIID *string `json:"restAPIID,omitempty"`
	StageName *string `json:"stageName,omitempty"`
}

A reference to a unique stage identified in the format {restApiId}/{stage}.

func (*StageKey) DeepCopy 

func (in *StageKey) DeepCopy() *StageKey

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageKey.

func (*StageKey) DeepCopyInto 

func (in *StageKey) DeepCopyInto(out *StageKey)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StageList added in v0.0.2 

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 added in v0.0.2 

func (in *StageList) DeepCopy() *StageList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageList.

func (*StageList) DeepCopyInto added in v0.0.2 

func (in *StageList) DeepCopyInto(out *StageList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StageList) DeepCopyObject added in v0.0.2 

func (in *StageList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StageSpec added in v0.0.2 

type StageSpec struct {

	// Whether cache clustering is enabled for the stage.
	CacheClusterEnabled *bool `json:"cacheClusterEnabled,omitempty"`
	// The stage's cache capacity in GB. For more information about choosing a cache
	// size, see Enabling API caching to enhance responsiveness (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
	CacheClusterSize *string `json:"cacheClusterSize,omitempty"`
	// The canary deployment settings of this stage.
	CanarySettings *CanarySettings `json:"canarySettings,omitempty"`
	// The identifier of the Deployment resource for the Stage resource.
	// +kubebuilder:validation:Required
	DeploymentID *string `json:"deploymentID"`
	// The description of the Stage resource.
	Description *string `json:"description,omitempty"`
	// The version of the associated API documentation.
	DocumentationVersion *string `json:"documentationVersion,omitempty"`
	// The string identifier of the associated RestApi.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	RestAPIID  *string                                  `json:"restAPIID,omitempty"`
	RestAPIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"restAPIRef,omitempty"`
	// The name for the Stage resource. Stage names can only contain alphanumeric
	// characters, hyphens, and underscores. Maximum length is 128 characters.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	// +kubebuilder:validation:Required
	StageName *string `json:"stageName"`
	// The key-value map of strings. The valid character set is [a-zA-Z+-=._:/].
	// The tag key can be up to 128 characters and must not start with aws:. The
	// tag value can be up to 256 characters.
	Tags map[string]*string `json:"tags,omitempty"`
	// Specifies whether active tracing with X-ray is enabled for the Stage.
	TracingEnabled *bool `json:"tracingEnabled,omitempty"`
	// A map that defines the stage variables for the new Stage resource. Variable
	// names can have alphanumeric and underscore characters, and the values must
	// match [A-Za-z0-9-._~:/?#&=,]+.
	Variables map[string]*string `json:"variables,omitempty"`
}

StageSpec defines the desired state of Stage.

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

func (*StageSpec) DeepCopy added in v0.0.2 

func (in *StageSpec) DeepCopy() *StageSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageSpec.

func (*StageSpec) DeepCopyInto added in v0.0.2 

func (in *StageSpec) DeepCopyInto(out *StageSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StageStatus added in v0.0.2 

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"`
	// Settings for logging access in this stage.
	// +kubebuilder:validation:Optional
	AccessLogSettings *AccessLogSettings `json:"accessLogSettings,omitempty"`
	// The status of the cache cluster for the stage, if enabled.
	// +kubebuilder:validation:Optional
	CacheClusterStatus *string `json:"cacheClusterStatus,omitempty"`
	// The identifier of a client certificate for an API stage.
	// +kubebuilder:validation:Optional
	ClientCertificateID *string `json:"clientCertificateID,omitempty"`
	// The timestamp when the stage was created.
	// +kubebuilder:validation:Optional
	CreatedDate *metav1.Time `json:"createdDate,omitempty"`
	// The timestamp when the stage last updated.
	// +kubebuilder:validation:Optional
	LastUpdatedDate *metav1.Time `json:"lastUpdatedDate,omitempty"`
	// A map that defines the method settings for a Stage resource. Keys (designated
	// as /{method_setting_key below) are method paths defined as {resource_path}/{http_method}
	// for an individual method override, or /\*/\* for overriding all methods in
	// the stage.
	// +kubebuilder:validation:Optional
	MethodSettings map[string]*MethodSetting `json:"methodSettings,omitempty"`
	// The ARN of the WebAcl associated with the Stage.
	// +kubebuilder:validation:Optional
	WebACLARN *string `json:"webACLARN,omitempty"`
}

StageStatus defines the observed state of Stage

func (*StageStatus) DeepCopy added in v0.0.2 

func (in *StageStatus) DeepCopy() *StageStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageStatus.

func (*StageStatus) DeepCopyInto added in v0.0.2 

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 added in v0.0.2 

type Stage_SDK struct {
	// Access log settings, including the access log format and access log destination
	// ARN.
	AccessLogSettings   *AccessLogSettings `json:"accessLogSettings,omitempty"`
	CacheClusterEnabled *bool              `json:"cacheClusterEnabled,omitempty"`
	// Returns the size of the CacheCluster.
	CacheClusterSize *string `json:"cacheClusterSize,omitempty"`
	// Returns the status of the CacheCluster.
	CacheClusterStatus *string `json:"cacheClusterStatus,omitempty"`
	// Configuration settings of a canary deployment.
	CanarySettings       *CanarySettings           `json:"canarySettings,omitempty"`
	ClientCertificateID  *string                   `json:"clientCertificateID,omitempty"`
	CreatedDate          *metav1.Time              `json:"createdDate,omitempty"`
	DeploymentID         *string                   `json:"deploymentID,omitempty"`
	Description          *string                   `json:"description,omitempty"`
	DocumentationVersion *string                   `json:"documentationVersion,omitempty"`
	LastUpdatedDate      *metav1.Time              `json:"lastUpdatedDate,omitempty"`
	MethodSettings       map[string]*MethodSetting `json:"methodSettings,omitempty"`
	StageName            *string                   `json:"stageName,omitempty"`
	Tags                 map[string]*string        `json:"tags,omitempty"`
	TracingEnabled       *bool                     `json:"tracingEnabled,omitempty"`
	Variables            map[string]*string        `json:"variables,omitempty"`
	WebACLARN            *string                   `json:"webACLARN,omitempty"`
}

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

func (*Stage_SDK) DeepCopy added in v0.0.2 

func (in *Stage_SDK) DeepCopy() *Stage_SDK

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Stage_SDK.

func (*Stage_SDK) DeepCopyInto added in v0.0.2 

func (in *Stage_SDK) DeepCopyInto(out *Stage_SDK)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TLSConfig 

type TLSConfig struct {
	InsecureSkipVerification *bool `json:"insecureSkipVerification,omitempty"`
}

Specifies the TLS configuration for an integration.

func (*TLSConfig) DeepCopy 

func (in *TLSConfig) DeepCopy() *TLSConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSConfig.

func (*TLSConfig) DeepCopyInto 

func (in *TLSConfig) DeepCopyInto(out *TLSConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ThrottleSettings added in v0.0.2 

type ThrottleSettings struct {
	BurstLimit *int64   `json:"burstLimit,omitempty"`
	RateLimit  *float64 `json:"rateLimit,omitempty"`
}

The API request rate limits.

func (*ThrottleSettings) DeepCopy added in v0.0.2 

func (in *ThrottleSettings) DeepCopy() *ThrottleSettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ThrottleSettings.

func (*ThrottleSettings) DeepCopyInto added in v0.0.2 

func (in *ThrottleSettings) DeepCopyInto(out *ThrottleSettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UnauthorizedCacheControlHeaderStrategy 

type UnauthorizedCacheControlHeaderStrategy string
const (
	UnauthorizedCacheControlHeaderStrategy_FAIL_WITH_403                   UnauthorizedCacheControlHeaderStrategy = "FAIL_WITH_403"
	UnauthorizedCacheControlHeaderStrategy_SUCCEED_WITHOUT_RESPONSE_HEADER UnauthorizedCacheControlHeaderStrategy = "SUCCEED_WITHOUT_RESPONSE_HEADER"
	UnauthorizedCacheControlHeaderStrategy_SUCCEED_WITH_RESPONSE_HEADER    UnauthorizedCacheControlHeaderStrategy = "SUCCEED_WITH_RESPONSE_HEADER"
)
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 added in v0.0.2 

func (in *VPCLink) DeepCopy() *VPCLink

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLink.

func (*VPCLink) DeepCopyInto added in v0.0.2 

func (in *VPCLink) DeepCopyInto(out *VPCLink)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VPCLink) DeepCopyObject added in v0.0.2 

func (in *VPCLink) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. 

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 added in v0.0.2 

func (in *VPCLinkList) DeepCopy() *VPCLinkList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLinkList.

func (*VPCLinkList) DeepCopyInto added in v0.0.2 

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 added in v0.0.2 

func (in *VPCLinkList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VPCLinkSpec added in v0.0.2 

type VPCLinkSpec struct {

	// The description of the VPC link.
	Description *string `json:"description,omitempty"`
	// The name used to label and identify the VPC link.
	// +kubebuilder:validation:Required
	Name *string `json:"name"`
	// The key-value map of strings. The valid character set is [a-zA-Z+-=._:/].
	// The tag key can be up to 128 characters and must not start with aws:. The
	// tag value can be up to 256 characters.
	Tags map[string]*string `json:"tags,omitempty"`
	// The ARN of the network load balancer of the VPC targeted by the VPC link.
	// The network load balancer must be owned by the same Amazon Web Services account
	// of the API owner.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set"
	// +kubebuilder:validation:Required
	TargetARNs []*string `json:"targetARNs"`
}

VpcLinkSpec defines the desired state of VpcLink.

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

func (*VPCLinkSpec) DeepCopy added in v0.0.2 

func (in *VPCLinkSpec) DeepCopy() *VPCLinkSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLinkSpec.

func (*VPCLinkSpec) DeepCopyInto added in v0.0.2 

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 identifier of the VpcLink. It is used in an Integration to reference
	// this VpcLink.
	// +kubebuilder:validation:Optional
	ID *string `json:"id,omitempty"`
	// The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING,
	// or FAILED. Deploying an API will wait if the status is PENDING and will fail
	// if the status is DELETING.
	// +kubebuilder:validation:Optional
	Status *string `json:"status,omitempty"`
	// A description about the VPC link status.
	// +kubebuilder:validation:Optional
	StatusMessage *string `json:"statusMessage,omitempty"`
}

VPCLinkStatus defines the observed state of VPCLink

func (*VPCLinkStatus) DeepCopy added in v0.0.2 

func (in *VPCLinkStatus) DeepCopy() *VPCLinkStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLinkStatus.

func (*VPCLinkStatus) DeepCopyInto added in v0.0.2 

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 added in v0.0.2 

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_PENDING   VPCLinkStatus_SDK = "PENDING"
)
type VPCLink_SDK struct {
	Description   *string            `json:"description,omitempty"`
	ID            *string            `json:"id,omitempty"`
	Name          *string            `json:"name,omitempty"`
	Status        *string            `json:"status,omitempty"`
	StatusMessage *string            `json:"statusMessage,omitempty"`
	Tags          map[string]*string `json:"tags,omitempty"`
	TargetARNs    []*string          `json:"targetARNs,omitempty"`
}

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC). 

func (in *VPCLink_SDK) DeepCopy() *VPCLink_SDK

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VPCLink_SDK. 

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.