Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-aws.Go to Latest
upbound/provider-aws@v1.1.0
UsagePlan
apigateway.aws.upbound.io
UsagePlan
upbound/provider-aws@v1.1.0apigateway.aws.upbound.io

UsagePlan is the Schema for the UsagePlans API. Provides an API Gateway Usage Plan.

Type

CRD

Group

apigateway.aws.upbound.io

Version

v1beta1

apiVersion: apigateway.aws.upbound.io/v1beta1

kind: UsagePlan

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

UsagePlanSpec defines the desired state of UsagePlan

forProvider
requiredobject
requiredobject

No description provided.

array

Associated API stages of the usage plan.

apiId
string
apiIdRef
object
object

Reference to a RestAPI in apigateway to populate apiId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a RestAPI in apigateway to populate apiId.

policy
object
object

Policies for selection.

resolve
string
stage
string
stageRef
object
object

Reference to a Stage in apigateway to populate stage.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Stage in apigateway to populate stage.

policy
object
object

Policies for selection.

resolve
string
array

The throttling limits of the usage plan.

path
string
rateLimit
number
name
string
array

The quota settings of the usage plan.

limit
number
offset
number
period
string
region
requiredstring
tags
object
array

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
object

Reference to a RestAPI in apigateway to populate apiId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a RestAPI in apigateway to populate apiId.

policy
object
object

Policies for selection.

resolve
string
stage
string
stageRef
object
object

Reference to a Stage in apigateway to populate stage.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Stage in apigateway to populate stage.

policy
object
object

Policies for selection.

resolve
string
array

The throttling limits of the usage plan.

path
string
rateLimit
number
name
string
array

The quota settings of the usage plan.

limit
number
offset
number
period
string
tags
object
array

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. 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

object

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

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

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.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
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. 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.

name
requiredstring
namespace
requiredstring
status
object
object

UsagePlanStatus defines the observed state of UsagePlan.

object

No description provided.

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
array

The quota settings of the usage plan.

limit
number
offset
number
period
string
tags
object
tagsAll
object
array

The throttling limits of the usage plan.

array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.