APISchemaProperty Struct
Contains details about the OpenAPI schema for a custom plugin.
For more information, see custom plugin OpenAPI schemas . You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';
const aPISchemaProperty: qbusiness.CfnPlugin.APISchemaProperty = {
payload: 'payload',
s3: {
bucket: 'bucket',
key: 'key',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness
a_pi_schema_property = qbusiness.CfnPlugin.APISchemaProperty(
payload="payload",
s3=qbusiness.CfnPlugin.S3Property(
bucket="bucket",
key="key"
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.qbusiness.*;
APISchemaProperty aPISchemaProperty = APISchemaProperty.builder()
.payload("payload")
.s3(S3Property.builder()
.bucket("bucket")
.key("key")
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QBusiness;
var aPISchemaProperty = new APISchemaProperty {
Payload = "payload",
S3 = new S3Property {
Bucket = "bucket",
Key = "key"
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
aPISchemaProperty := &APISchemaProperty{
Payload: jsii.String("payload"),
S3: &S3Property{
Bucket: jsii.String("bucket"),
Key: jsii.String("key"),
},
}
Properties
payloadoptionalstringpayloadoptionalstrpayloadoptionalStringPayloadoptionalstringPayloadoptional*string #The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
s3optionalIResolvable | CfnPlugin.S3Propertys3optionaltyping.Union[IResolvable, S3Property]s3optionalIResolvableS3optionalIResolvableS3optionalinterface{} #Contains details about the S3 object containing the OpenAPI schema for a custom plugin.
The schema could be in either JSON or YAML format.