UsagePlan is the Schema for the UsagePlans API. Provides an API Gateway Usage Plan.
Type
CRD
Group
apigateway.aws.upbound.io
Version
apiVersion: apigateway.aws.upbound.io/v1beta1
kind: UsagePlan
UsagePlanSpec defines the desired state of UsagePlan
No description provided.
Associated API stages of the usage plan.
Reference to a RestAPI in apigateway to populate apiId.
Policies for referencing.
Selector for a RestAPI in apigateway to populate apiId.
Policies for selection.
Reference to a Stage in apigateway to populate stage.
Policies for referencing.
Selector for a Stage in apigateway to populate stage.
Policies for selection.
The throttling limits of the usage plan.
The throttling limits of the usage plan.
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.
Associated API stages of the usage plan.
Reference to a RestAPI in apigateway to populate apiId.
Policies for referencing.
Selector for a RestAPI in apigateway to populate apiId.
Policies for selection.
Reference to a Stage in apigateway to populate stage.
Policies for referencing.
Selector for a Stage in apigateway to populate stage.
Policies for selection.
The throttling limits of the usage plan.
The throttling limits of the usage plan.
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. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. 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
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config 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.
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. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
UsagePlanStatus defines the observed state of UsagePlan.
No description provided.
The throttling limits of the usage plan.
Conditions of the resource.
example
apiVersion: apigateway.aws.upbound.io/v1beta1
kind: UsagePlan
metadata:
labels:
testing.upbound.io/example-name: stage
name: example
spec:
forProvider:
apiStages:
- apiIdSelector:
matchLabels:
testing.upbound.io/example-name: stage
stageSelector:
matchLabels:
testing.upbound.io/example-name: stage
- apiIdSelector:
matchLabels:
testing.upbound.io/example-name: stage
stageSelector:
matchLabels:
testing.upbound.io/example-name: stage
description: my description
name: my-usage-plan
productCode: MYCODE
quotaSettings:
- limit: 20
offset: 2
period: WEEK
region: us-west-1
throttleSettings:
- burstLimit: 5
rateLimit: 10