DocumentationPart is the Schema for the DocumentationParts API. Provides a settings of an API Gateway Documentation Part.
Type
CRD
Group
apigateway.aws.upbound.io
Version
v1beta1
apiVersion: apigateway.aws.upbound.io/v1beta1
kind: DocumentationPart
DocumentationPartSpec defines the desired state of DocumentationPart
No description provided.
The location of the targeted API entity of the to-be-created documentation part. See below.
Reference to a RestAPI in apigateway to populate restApiId.
Policies for referencing.
Selector for a RestAPI in apigateway to populate restApiId.
Policies for selection.
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef
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.
DocumentationPartStatus defines the observed state of DocumentationPart.
No description provided.
Conditions of the resource.
example
apiVersion: apigateway.aws.upbound.io/v1beta1
kind: DocumentationPart
metadata:
labels:
testing.upbound.io/example-name: restapi
name: example
spec:
forProvider:
location:
- type: API
properties: '{"description":"Example"}'
region: us-west-1
restApiIdSelector:
matchLabels:
testing.upbound.io/example-name: restapi
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.