# Copyright (c) 2012-2025, Mark Peek <mark@peek.org>
# All rights reserved.
#
# See LICENSE file for full license.
#
# *** Do not modify - this file is autogenerated ***
from . import AWSObject, AWSProperty, PropsDictType, Tags
from .validators import boolean, integer
from .validators.opensearchservice import validate_search_service_engine_version
[docs]class AppConfig(AWSProperty):
"""
`AppConfig <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-appconfig.html>`__
"""
props: PropsDictType = {
"Key": (str, True),
"Value": (str, True),
}
[docs]class DataSource(AWSProperty):
"""
`DataSource <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-datasource.html>`__
"""
props: PropsDictType = {
"DataSourceArn": (str, True),
"DataSourceDescription": (str, False),
}
[docs]class IamIdentityCenterOptions(AWSProperty):
"""
`IamIdentityCenterOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
"IamIdentityCenterInstanceArn": (str, False),
"IamRoleForIdentityCenterApplicationArn": (str, False),
}
[docs]class Application(AWSObject):
"""
`Application <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html>`__
"""
resource_type = "AWS::OpenSearchService::Application"
props: PropsDictType = {
"AppConfigs": ([AppConfig], False),
"DataSources": ([DataSource], False),
"Endpoint": (str, False),
"IamIdentityCenterOptions": (IamIdentityCenterOptions, False),
"KmsKeyArn": (str, False),
"Name": (str, True),
"Tags": (Tags, False),
}
[docs]class S3VectorsEngine(AWSProperty):
"""
`S3VectorsEngine <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-s3vectorsengine.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, True),
}
[docs]class ServerlessVectorAcceleration(AWSProperty):
"""
`ServerlessVectorAcceleration <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-serverlessvectoracceleration.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
}
[docs]class AIMLOptions(AWSProperty):
"""
`AIMLOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-aimloptions.html>`__
"""
props: PropsDictType = {
"S3VectorsEngine": (S3VectorsEngine, False),
"ServerlessVectorAcceleration": (ServerlessVectorAcceleration, False),
}
[docs]class IAMFederationOptions(AWSProperty):
"""
`IAMFederationOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-iamfederationoptions.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
"RolesKey": (str, False),
"SubjectKey": (str, False),
}
[docs]class JWTOptions(AWSProperty):
"""
`JWTOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
"PublicKey": (str, False),
"RolesKey": (str, False),
"SubjectKey": (str, False),
}
[docs]class MasterUserOptions(AWSProperty):
"""
`MasterUserOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html>`__
"""
props: PropsDictType = {
"MasterUserARN": (str, False),
"MasterUserName": (str, False),
"MasterUserPassword": (str, False),
}
[docs]class Idp(AWSProperty):
"""
`Idp <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.html>`__
"""
props: PropsDictType = {
"EntityId": (str, True),
"MetadataContent": (str, True),
}
[docs]class SAMLOptions(AWSProperty):
"""
`SAMLOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
"Idp": (Idp, False),
"MasterBackendRole": (str, False),
"MasterUserName": (str, False),
"RolesKey": (str, False),
"SessionTimeoutMinutes": (integer, False),
"SubjectKey": (str, False),
}
[docs]class ColdStorageOptions(AWSProperty):
"""
`ColdStorageOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-coldstorageoptions.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
}
[docs]class NodeConfig(AWSProperty):
"""
`NodeConfig <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeconfig.html>`__
"""
props: PropsDictType = {
"Count": (integer, False),
"Enabled": (boolean, False),
"Type": (str, False),
}
[docs]class NodeOption(AWSProperty):
"""
`NodeOption <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeoption.html>`__
"""
props: PropsDictType = {
"NodeConfig": (NodeConfig, False),
"NodeType": (str, False),
}
[docs]class ZoneAwarenessConfig(AWSProperty):
"""
`ZoneAwarenessConfig <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-zoneawarenessconfig.html>`__
"""
props: PropsDictType = {
"AvailabilityZoneCount": (integer, False),
}
[docs]class ClusterConfig(AWSProperty):
"""
`ClusterConfig <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html>`__
"""
props: PropsDictType = {
"ColdStorageOptions": (ColdStorageOptions, False),
"DedicatedMasterCount": (integer, False),
"DedicatedMasterEnabled": (boolean, False),
"DedicatedMasterType": (str, False),
"InstanceCount": (integer, False),
"InstanceType": (str, False),
"MultiAZWithStandbyEnabled": (boolean, False),
"NodeOptions": ([NodeOption], False),
"WarmCount": (integer, False),
"WarmEnabled": (boolean, False),
"WarmType": (str, False),
"ZoneAwarenessConfig": (ZoneAwarenessConfig, False),
"ZoneAwarenessEnabled": (boolean, False),
}
[docs]class CognitoOptions(AWSProperty):
"""
`CognitoOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
"IdentityPoolId": (str, False),
"RoleArn": (str, False),
"UserPoolId": (str, False),
}
[docs]class DeploymentStrategyOptions(AWSProperty):
"""
`DeploymentStrategyOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-deploymentstrategyoptions.html>`__
"""
props: PropsDictType = {
"DeploymentStrategy": (str, False),
}
[docs]class DomainEndpointOptions(AWSProperty):
"""
`DomainEndpointOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html>`__
"""
props: PropsDictType = {
"CustomEndpoint": (str, False),
"CustomEndpointCertificateArn": (str, False),
"CustomEndpointEnabled": (boolean, False),
"EnforceHTTPS": (boolean, False),
"TLSSecurityPolicy": (str, False),
}
[docs]class EBSOptions(AWSProperty):
"""
`EBSOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html>`__
"""
props: PropsDictType = {
"EBSEnabled": (boolean, False),
"Iops": (integer, False),
"Throughput": (integer, False),
"VolumeSize": (integer, False),
"VolumeType": (str, False),
}
[docs]class EncryptionAtRestOptions(AWSProperty):
"""
`EncryptionAtRestOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
"KmsKeyId": (str, False),
}
[docs]class IdentityCenterOptions(AWSProperty):
"""
`IdentityCenterOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html>`__
"""
props: PropsDictType = {
"EnabledAPIAccess": (boolean, False),
"IdentityCenterApplicationARN": (str, False),
"IdentityCenterInstanceARN": (str, False),
"IdentityStoreId": (str, False),
"RolesKey": (str, False),
"SubjectKey": (str, False),
}
[docs]class LogPublishingOption(AWSProperty):
"""
`LogPublishingOption <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html>`__
"""
props: PropsDictType = {
"CloudWatchLogsLogGroupArn": (str, False),
"Enabled": (boolean, False),
}
[docs]class NodeToNodeEncryptionOptions(AWSProperty):
"""
`NodeToNodeEncryptionOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
}
[docs]class WindowStartTime(AWSProperty):
"""
`WindowStartTime <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-windowstarttime.html>`__
"""
props: PropsDictType = {
"Hours": (integer, True),
"Minutes": (integer, True),
}
[docs]class OffPeakWindow(AWSProperty):
"""
`OffPeakWindow <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindow.html>`__
"""
props: PropsDictType = {
"WindowStartTime": (WindowStartTime, False),
}
[docs]class OffPeakWindowOptions(AWSProperty):
"""
`OffPeakWindowOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindowoptions.html>`__
"""
props: PropsDictType = {
"Enabled": (boolean, False),
"OffPeakWindow": (OffPeakWindow, False),
}
[docs]class SnapshotOptions(AWSProperty):
"""
`SnapshotOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html>`__
"""
props: PropsDictType = {
"AutomatedSnapshotStartHour": (integer, False),
}
[docs]class SoftwareUpdateOptions(AWSProperty):
"""
`SoftwareUpdateOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-softwareupdateoptions.html>`__
"""
props: PropsDictType = {
"AutoSoftwareUpdateEnabled": (boolean, False),
}
[docs]class VPCOptions(AWSProperty):
"""
`VPCOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html>`__
"""
props: PropsDictType = {
"SecurityGroupIds": ([str], False),
"SubnetIds": ([str], False),
}
[docs]class Domain(AWSObject):
"""
`Domain <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html>`__
"""
resource_type = "AWS::OpenSearchService::Domain"
props: PropsDictType = {
"AIMLOptions": (AIMLOptions, False),
"AccessPolicies": (dict, False),
"AdvancedOptions": (dict, False),
"AdvancedSecurityOptions": (AdvancedSecurityOptionsInput, False),
"ClusterConfig": (ClusterConfig, False),
"CognitoOptions": (CognitoOptions, False),
"DeploymentStrategyOptions": (DeploymentStrategyOptions, False),
"DomainEndpointOptions": (DomainEndpointOptions, False),
"DomainName": (str, False),
"EBSOptions": (EBSOptions, False),
"EncryptionAtRestOptions": (EncryptionAtRestOptions, False),
"EngineVersion": (validate_search_service_engine_version, False),
"IPAddressType": (str, False),
"IdentityCenterOptions": (IdentityCenterOptions, False),
"LogPublishingOptions": (dict, False),
"NodeToNodeEncryptionOptions": (NodeToNodeEncryptionOptions, False),
"OffPeakWindowOptions": (OffPeakWindowOptions, False),
"SkipShardMigrationWait": (boolean, False),
"SnapshotOptions": (SnapshotOptions, False),
"SoftwareUpdateOptions": (SoftwareUpdateOptions, False),
"Tags": (Tags, False),
"VPCOptions": (VPCOptions, False),
}
[docs]class ServiceSoftwareOptions(AWSProperty):
"""
`ServiceSoftwareOptions <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html>`__
"""
props: PropsDictType = {
"AutomatedUpdateDate": (str, False),
"Cancellable": (boolean, False),
"CurrentVersion": (str, False),
"Description": (str, False),
"NewVersion": (str, False),
"OptionalDeployment": (boolean, False),
"UpdateAvailable": (boolean, False),
"UpdateStatus": (str, False),
}