Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-opensearchservice-domain.json
Parent schema serverless-framework-configuration
Type: object

An example resource schema demonstrating some basic constructs and validation rules.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

ClusterConfig object
11 nested properties
InstanceCount integer
WarmEnabled boolean
WarmCount integer
DedicatedMasterEnabled boolean
ZoneAwarenessConfig object
1 nested properties
AvailabilityZoneCount integer
DedicatedMasterCount integer
InstanceType string | Aws_CF_FunctionString
WarmType string | Aws_CF_FunctionString
ZoneAwarenessEnabled boolean
DedicatedMasterType string | Aws_CF_FunctionString
MultiAZWithStandbyEnabled boolean
DomainName string | Aws_CF_FunctionString
AccessPolicies object
EngineVersion string | Aws_CF_FunctionString
AdvancedOptions object
LogPublishingOptions object
SnapshotOptions object
1 nested properties
AutomatedSnapshotStartHour integer
VPCOptions object
2 nested properties
SecurityGroupIds string[]
uniqueItems=true
SubnetIds string[]
uniqueItems=true
NodeToNodeEncryptionOptions object
1 nested properties
Enabled boolean
DomainEndpointOptions object
5 nested properties
CustomEndpointCertificateArn string | Aws_CF_FunctionString
CustomEndpointEnabled boolean
EnforceHTTPS boolean
CustomEndpoint string | Aws_CF_FunctionString
TLSSecurityPolicy string | Aws_CF_FunctionString
CognitoOptions object
4 nested properties
Enabled boolean
IdentityPoolId string | Aws_CF_FunctionString
UserPoolId string | Aws_CF_FunctionString
RoleArn string | Aws_CF_FunctionString
AdvancedSecurityOptions object
6 nested properties
Enabled boolean
MasterUserOptions object
3 nested properties
MasterUserPassword string | Aws_CF_FunctionString
MasterUserName string | Aws_CF_FunctionString
MasterUserARN string | Aws_CF_FunctionString
InternalUserDatabaseEnabled boolean
AnonymousAuthEnabled boolean
SAMLOptions object
7 nested properties
Enabled boolean
Idp object
2 nested properties
MetadataContent string | Aws_CF_FunctionString required
EntityId string | Aws_CF_FunctionString required
MasterUserName string | Aws_CF_FunctionString
MasterBackendRole string | Aws_CF_FunctionString
SubjectKey string | Aws_CF_FunctionString
RolesKey string | Aws_CF_FunctionString
SessionTimeoutMinutes integer
AnonymousAuthDisableDate string | Aws_CF_FunctionString
EBSOptions object
5 nested properties
EBSEnabled boolean
VolumeType string | Aws_CF_FunctionString
Iops integer
VolumeSize integer
Throughput integer
EncryptionAtRestOptions object
2 nested properties
KmsKeyId string | Aws_CF_FunctionString
Enabled boolean
Tags Tag[]

An arbitrary set of tags (key-value pairs) for this Domain.

uniqueItems=true
OffPeakWindowOptions object
2 nested properties
Enabled boolean
OffPeakWindow object
1 nested properties
WindowStartTime object
2 nested properties
Hours integer required
min=0max=23
Minutes integer required
min=0max=59
SoftwareUpdateOptions object
1 nested properties
AutoSoftwareUpdateEnabled boolean

Definitions

ZoneAwarenessConfig object
AvailabilityZoneCount integer
ClusterConfig object
InstanceCount integer
WarmEnabled boolean
WarmCount integer
DedicatedMasterEnabled boolean
ZoneAwarenessConfig object
1 nested properties
AvailabilityZoneCount integer
DedicatedMasterCount integer
InstanceType string | Aws_CF_FunctionString
WarmType string | Aws_CF_FunctionString
ZoneAwarenessEnabled boolean
DedicatedMasterType string | Aws_CF_FunctionString
MultiAZWithStandbyEnabled boolean
LogPublishingOption object
CloudWatchLogsLogGroupArn string | Aws_CF_FunctionString
Enabled boolean
SnapshotOptions object
AutomatedSnapshotStartHour integer
VPCOptions object
SecurityGroupIds string[]
uniqueItems=true
SubnetIds string[]
uniqueItems=true
NodeToNodeEncryptionOptions object
Enabled boolean
DomainEndpointOptions object
CustomEndpointCertificateArn string | Aws_CF_FunctionString
CustomEndpointEnabled boolean
EnforceHTTPS boolean
CustomEndpoint string | Aws_CF_FunctionString
TLSSecurityPolicy string | Aws_CF_FunctionString
CognitoOptions object
Enabled boolean
IdentityPoolId string | Aws_CF_FunctionString
UserPoolId string | Aws_CF_FunctionString
RoleArn string | Aws_CF_FunctionString
MasterUserOptions object
MasterUserPassword string | Aws_CF_FunctionString
MasterUserName string | Aws_CF_FunctionString
MasterUserARN string | Aws_CF_FunctionString
Idp object
MetadataContent string | Aws_CF_FunctionString required
EntityId string | Aws_CF_FunctionString required
SAMLOptions object
Enabled boolean
Idp object
2 nested properties
MetadataContent string | Aws_CF_FunctionString required
EntityId string | Aws_CF_FunctionString required
MasterUserName string | Aws_CF_FunctionString
MasterBackendRole string | Aws_CF_FunctionString
SubjectKey string | Aws_CF_FunctionString
RolesKey string | Aws_CF_FunctionString
SessionTimeoutMinutes integer
AdvancedSecurityOptionsInput object
Enabled boolean
MasterUserOptions object
3 nested properties
MasterUserPassword string | Aws_CF_FunctionString
MasterUserName string | Aws_CF_FunctionString
MasterUserARN string | Aws_CF_FunctionString
InternalUserDatabaseEnabled boolean
AnonymousAuthEnabled boolean
SAMLOptions object
7 nested properties
Enabled boolean
Idp object
2 nested properties
MetadataContent string | Aws_CF_FunctionString required
EntityId string | Aws_CF_FunctionString required
MasterUserName string | Aws_CF_FunctionString
MasterBackendRole string | Aws_CF_FunctionString
SubjectKey string | Aws_CF_FunctionString
RolesKey string | Aws_CF_FunctionString
SessionTimeoutMinutes integer
AnonymousAuthDisableDate string | Aws_CF_FunctionString
EBSOptions object
EBSEnabled boolean
VolumeType string | Aws_CF_FunctionString
Iops integer
VolumeSize integer
Throughput integer
EncryptionAtRestOptions object
KmsKeyId string | Aws_CF_FunctionString
Enabled boolean
Tag object
Value string | Aws_CF_FunctionString required

The key of the tag.

Key string | Aws_CF_FunctionString required

The value of the tag.

ServiceSoftwareOptions object
CurrentVersion string | Aws_CF_FunctionString
NewVersion string | Aws_CF_FunctionString
UpdateAvailable boolean
Cancellable boolean
UpdateStatus string | Aws_CF_FunctionString
Description string | Aws_CF_FunctionString
AutomatedUpdateDate string | Aws_CF_FunctionString
OptionalDeployment boolean
WindowStartTime object
Hours integer required
min=0max=23
Minutes integer required
min=0max=59
OffPeakWindow object
WindowStartTime object
2 nested properties
Hours integer required
min=0max=23
Minutes integer required
min=0max=59
OffPeakWindowOptions object
Enabled boolean
OffPeakWindow object
1 nested properties
WindowStartTime object
2 nested properties
Hours integer required
min=0max=23
Minutes integer required
min=0max=59
SoftwareUpdateOptions object
AutoSoftwareUpdateEnabled boolean