UsagePlanUsagePlan is the Schema for the UsagePlans API. Provides an API Gateway Usage Plan.
TypeMR
Providerprovider-aws-apigateway
Groupapigateway.aws.m.upbound.io
Scopenamespaced
Versionv1beta1

1apiVersion: apigateway.aws.m.upbound.io/v1beta1

2kind: UsagePlan

kind
string
metadata
object
spec
object

UsagePlanSpec defines the desired state of UsagePlan

forProvider
required
object

(No description available)

array

Associated API stages of the usage plan.

apiId
string
apiIdRef
object

Reference to a RestAPI in apigateway to populate apiId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a RestAPI in apigateway to populate apiId.

namespace
string
policy
object

Policies for selection.

resolve
string
stage
string
stageRef
object

Reference to a Stage in apigateway to populate stage.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Stage in apigateway to populate stage.

namespace
string
policy
object

Policies for selection.

resolve
string
array

The throttling limits of the usage plan.

path
string
rateLimit
number
name
string
object

The quota settings of the usage plan.

limit
number
offset
number
period
string
region
required
string
tags
object
object

The throttling limits of the usage plan.

object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

Associated API stages of the usage plan.

apiId
string
apiIdRef
object

Reference to a RestAPI in apigateway to populate apiId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a RestAPI in apigateway to populate apiId.

namespace
string
policy
object

Policies for selection.

resolve
string
stage
string
stageRef
object

Reference to a Stage in apigateway to populate stage.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Stage in apigateway to populate stage.

namespace
string
policy
object

Policies for selection.

resolve
string
array

The throttling limits of the usage plan.

path
string
rateLimit
number
name
string
object

The quota settings of the usage plan.

limit
number
offset
number
period
string
tags
object
object

The throttling limits of the usage plan.

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

kind
required
string
name
required
string
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

name
required
string
status
object

UsagePlanStatus defines the observed state of UsagePlan.

object

(No description available)

array

Associated API stages of the usage plan.

apiId
string
stage
string
array

The throttling limits of the usage plan.

path
string
rateLimit
number
arn
string
id
string
name
string
object

The quota settings of the usage plan.

limit
number
offset
number
period
string
region
string
tags
object
tagsAll
object
object

The throttling limits of the usage plan.

array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string