Skip to content
v2.275.0

Domain L2 construct ​

Provides an Elasticsearch domain.

Example ​

ts
const domain = new es.Domain(this, 'Domain', {
  version: es.ElasticsearchVersion.V7_4,
  ebs: {
    volumeSize: 100,
    volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD,
  },
  nodeToNodeEncryption: true,
  encryptionAtRest: {
    enabled: true,
  },
});
python
domain = es.Domain(self, "Domain",
    version=es.ElasticsearchVersion.V7_4,
    ebs=es.EbsOptions(
        volume_size=100,
        volume_type=ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
    ),
    node_to_node_encryption=True,
    encryption_at_rest=es.EncryptionAtRestOptions(
        enabled=True
    )
)
java
Domain domain = Domain.Builder.create(this, "Domain")
        .version(ElasticsearchVersion.V7_4)
        .ebs(EbsOptions.builder()
                .volumeSize(100)
                .volumeType(EbsDeviceVolumeType.GENERAL_PURPOSE_SSD)
                .build())
        .nodeToNodeEncryption(true)
        .encryptionAtRest(EncryptionAtRestOptions.builder()
                .enabled(true)
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
var domain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_4,
    Ebs = new EbsOptions {
        VolumeSize = 100,
        VolumeType = EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
    },
    NodeToNodeEncryption = true,
    EncryptionAtRest = new EncryptionAtRestOptions {
        Enabled = true
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
domain := es.NewDomain(this, jsii.String("Domain"), &DomainProps{
	Version: es.ElasticsearchVersion_V7_4(),
	Ebs: &EbsOptions{
		VolumeSize: jsii.Number(100),
		VolumeType: ec2.EbsDeviceVolumeType_GENERAL_PURPOSE_SSD,
	},
	NodeToNodeEncryption: jsii.Boolean(true),
	EncryptionAtRest: &EncryptionAtRestOptions{
		Enabled: jsii.Boolean(true),
	},
})

Initializer ​

ts
new Domain(scope: Construct, id: string, props: DomainProps)
python
Domain(scope: Construct, id: str, props: DomainProps)
java
new Domain(Construct scope, String id, DomainProps props)
csharp
new Domain(Construct scope, string id, DomainProps props)
go
NewDomain(Scope Construct, Id *string, Props DomainProps)

Construct Props ​

accessPoliciesoptionalPolicyStatement[]access_policiesoptionaltyping.List[PolicyStatement]accessPoliciesoptionalList<PolicyStatement>AccessPoliciesoptionalPolicyStatement[]AccessPoliciesoptional*[]PolicyStatementdeprecated#
use opensearchservice module instead

Default: No access policies.

advancedOptionsoptional{ [key: string]: string }advanced_optionsoptionaltyping.Mapping[str, str]advancedOptionsoptionalMap<String, String>AdvancedOptionsoptionalIDictionary<string, string>AdvancedOptionsoptional*map[string]*stringdeprecated#
use opensearchservice module instead

Default: no advanced options are specified

automatedSnapshotStartHouroptionalnumberautomated_snapshot_start_houroptionalint | floatautomatedSnapshotStartHouroptionalNumberAutomatedSnapshotStartHouroptionaldoubleAutomatedSnapshotStartHouroptional*float64deprecated#
use opensearchservice module instead

Default: Hourly automated snapshots not used

Only applies for Elasticsearch versions below 5.3.

capacityoptionalCapacityConfigcapacityoptionalCapacityConfigcapacityoptionalCapacityConfigCapacityoptionalCapacityConfigCapacityoptionalCapacityConfigdeprecated#
use opensearchservice module instead

Default: 1 r5.large.elasticsearch data node; no dedicated master nodes.

cognitoKibanaAuthoptionalCognitoOptionscognito_kibana_authoptionalCognitoOptionscognitoKibanaAuthoptionalCognitoOptionsCognitoKibanaAuthoptionalCognitoOptionsCognitoKibanaAuthoptionalCognitoOptionsdeprecated#
use opensearchservice module instead

Default: Cognito not used for authentication to Kibana.

customEndpointoptionalCustomEndpointOptionscustom_endpointoptionalCustomEndpointOptionscustomEndpointoptionalCustomEndpointOptionsCustomEndpointoptionalCustomEndpointOptionsCustomEndpointoptionalCustomEndpointOptionsdeprecated#
use opensearchservice module instead

Default: no custom domain endpoint will be configured

If you specify a Route53 hosted zone it will create a CNAME record and use DNS validation for the certificate

domainNameoptionalstringdomain_nameoptionalstrdomainNameoptionalStringDomainNameoptionalstringDomainNameoptional*stringdeprecated#
use opensearchservice module instead

Default: A name will be auto-generated.

ebsoptionalEbsOptionsebsoptionalEbsOptionsebsoptionalEbsOptionsEbsoptionalEbsOptionsEbsoptionalEbsOptionsdeprecated#
use opensearchservice module instead

Default: 10 GiB General Purpose (SSD) volumes per node.

notes

For more information, see [Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

enableVersionUpgradeoptionalbooleanenable_version_upgradeoptionalboolenableVersionUpgradeoptionalBooleanEnableVersionUpgradeoptionalboolEnableVersionUpgradeoptional*bool= falsedeprecated#
use opensearchservice module instead
encryptionAtRestoptionalEncryptionAtRestOptionsencryption_at_restoptionalEncryptionAtRestOptionsencryptionAtRestoptionalEncryptionAtRestOptionsEncryptionAtRestoptionalEncryptionAtRestOptionsEncryptionAtRestoptionalEncryptionAtRestOptionsdeprecated#
use opensearchservice module instead

Default: No encryption at rest

enforceHttpsoptionalbooleanenforce_httpsoptionalboolenforceHttpsoptionalBooleanEnforceHttpsoptionalboolEnforceHttpsoptional*bool= falsedeprecated#
use opensearchservice module instead
fineGrainedAccessControloptionalAdvancedSecurityOptionsfine_grained_access_controloptionalAdvancedSecurityOptionsfineGrainedAccessControloptionalAdvancedSecurityOptionsFineGrainedAccessControloptionalAdvancedSecurityOptionsFineGrainedAccessControloptionalAdvancedSecurityOptionsdeprecated#
use opensearchservice module instead

Default: fine-grained access control is disabled

Requires Elasticsearch version 6.7 or later. Enabling fine-grained access control also requires encryption of data at rest and node-to-node encryption, along with enforced HTTPS.

loggingoptionalLoggingOptionsloggingoptionalLoggingOptionsloggingoptionalLoggingOptionsLoggingoptionalLoggingOptionsLoggingoptionalLoggingOptionsdeprecated#
use opensearchservice module instead

Default: No logs are published

nodeToNodeEncryptionoptionalbooleannode_to_node_encryptionoptionalboolnodeToNodeEncryptionoptionalBooleanNodeToNodeEncryptionoptionalboolNodeToNodeEncryptionoptional*booldeprecated#
use opensearchservice module instead

Default: Node to node encryption is not enabled.

Requires Elasticsearch version 6.0 or later.

removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.RETAINdeprecated#
use opensearchservice module instead
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroupdeprecated#
use opensearchservice module instead

Default: One new security group is created.

Only used if vpc is specified.

tlsSecurityPolicyoptionalTLSSecurityPolicytls_security_policyoptionalTLSSecurityPolicytlsSecurityPolicyoptionalTLSSecurityPolicyTlsSecurityPolicyoptionalTLSSecurityPolicyTlsSecurityPolicyoptionalTLSSecurityPolicy= TLSSecurityPolicy.TLS_1_0deprecated#
use opensearchservice module instead
useUnsignedBasicAuthoptionalbooleanuse_unsigned_basic_authoptionalbooluseUnsignedBasicAuthoptionalBooleanUseUnsignedBasicAuthoptionalboolUseUnsignedBasicAuthoptional*bool= falsedeprecated#
use opensearchservice module instead
notes

If no master user is provided a default master user with username admin and a dynamically generated password stored in KMS is created. The password can be retrieved by getting masterUserPassword from the domain instance.

Setting this to true will also add an access policy that allows unsigned access, enable node to node encryption, encryption at rest. If conflicting settings are encountered (like disabling encryption at rest) enabling this setting will cause a failure.

use opensearchservice module instead
vpcoptionalIVpcvpcoptionalIVpcvpcoptionalIVpcVpcoptionalIVpcVpcoptionalIVpcdeprecated#
use opensearchservice module instead

Default: Domain is not placed in a VPC.

vpcSubnetsoptionalSubnetSelection[]vpc_subnetsoptionaltyping.List[SubnetSelection]vpcSubnetsoptionalList<SubnetSelection>VpcSubnetsoptionalSubnetSelection[]VpcSubnetsoptional*[]SubnetSelectiondeprecated#
use opensearchservice module instead

Default: All private subnets.

You must provide one subnet for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three Availability Zone domain.

Only used if vpc is specified.

zoneAwarenessoptionalZoneAwarenessConfigzone_awarenessoptionalZoneAwarenessConfigzoneAwarenessoptionalZoneAwarenessConfigZoneAwarenessoptionalZoneAwarenessConfigZoneAwarenessoptionalZoneAwarenessConfigdeprecated#
use opensearchservice module instead

Default: no zone awareness (1 AZ)

Properties ​

appLogGroupmay be undefinedILogGroupapp_log_groupmay be undefinedILogGroupappLogGroupmay be undefinedILogGroupAppLogGroupmay be undefinedILogGroupAppLogGroupmay be undefinedILogGroupdeprecated#
use opensearchservice module instead
auditLogGroupmay be undefinedILogGroupaudit_log_groupmay be undefinedILogGroupauditLogGroupmay be undefinedILogGroupAuditLogGroupmay be undefinedILogGroupAuditLogGroupmay be undefinedILogGroupdeprecated#
use opensearchservice module instead
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsdeprecated#
use opensearchservice module instead

This will throw an error in case the domain is not placed inside a VPC.

domainArnstringdomain_arnstrdomainArnStringDomainArnstringDomainArn*string#
Arn of the Elasticsearch domain.
domainEndpointstringdomain_endpointstrdomainEndpointStringDomainEndpointstringDomainEndpoint*stringdeprecated#
use opensearchservice module instead
domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string#
Domain name of the Elasticsearch domain.
A reference to a Domain resource.
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Collection of grant methods for a Domain.
masterUserPasswordmay be undefinedSecretValuemaster_user_passwordmay be undefinedSecretValuemasterUserPasswordmay be undefinedSecretValueMasterUserPasswordmay be undefinedSecretValueMasterUserPasswordmay be undefinedSecretValuedeprecated#
use opensearchservice module instead
nodeNodenodeNodenodeNodeNodeNodeNodeNode#
The tree node.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#
Uniquely identifies this class.
slowIndexLogGroupmay be undefinedILogGroupslow_index_log_groupmay be undefinedILogGroupslowIndexLogGroupmay be undefinedILogGroupSlowIndexLogGroupmay be undefinedILogGroupSlowIndexLogGroupmay be undefinedILogGroupdeprecated#
use opensearchservice module instead
slowSearchLogGroupmay be undefinedILogGroupslow_search_log_groupmay be undefinedILogGroupslowSearchLogGroupmay be undefinedILogGroupSlowSearchLogGroupmay be undefinedILogGroupSlowSearchLogGroupmay be undefinedILogGroupdeprecated#
use opensearchservice module instead
stackStackstackStackstackStackStackStackStackStack#
The stack in which this resource is defined.

Methods ​

addAccessPolicies(...accessPolicyStatements: PolicyStatement[]): voiddef add_access_policies(self, access_policy_statements: PolicyStatement) -> Nonepublic void addAccessPolicies(PolicyStatement accessPolicyStatements)public void AddAccessPolicies(PolicyStatement accessPolicyStatements)func AddAccessPolicies(AccessPolicyStatements PolicyStatement)deprecated#
use opensearchservice module instead
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#
Override the cross-stack reference strength for this resource.
notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromDomainAttributes(scope: Construct, id: string, attrs: DomainAttributes): IDomain@staticmethod def from_domain_attributes(scope: Construct, id: str, attrs: DomainAttributes) -> IDomainpublic static IDomain fromDomainAttributes(Construct scope, String id, DomainAttributes attrs)public static IDomain FromDomainAttributes(Construct scope, string id, DomainAttributes attrs)func FromDomainAttributes(Scope Construct, Id *string, Attrs DomainAttributes) IDomainstaticdeprecated#
use opensearchservice module instead
3 parameters

Parameters

  • scopescopescopescopeScope — The parent creating construct (usually this).
  • ididididId — The construct's name.
  • attrsattrsattrsattrsAttrs — A DomainAttributes object.
fromDomainEndpoint(scope: Construct, id: string, domainEndpoint: string): IDomain@staticmethod def from_domain_endpoint(scope: Construct, id: str, domain_endpoint: str) -> IDomainpublic static IDomain fromDomainEndpoint(Construct scope, String id, String domainEndpoint)public static IDomain FromDomainEndpoint(Construct scope, string id, string domainEndpoint)func FromDomainEndpoint(Scope Construct, Id *string, DomainEndpoint *string) IDomainstaticdeprecated#
use opensearchservice module instead
3 parameters

Parameters

  • scopescopescopescopeScope — The parent creating construct (usually this).
  • ididididId — The construct's name.
  • domainEndpointdomain_endpointdomainEndpointdomainEndpointDomainEndpoint — The domain's endpoint.
grantIndexRead(index: string, identity: IGrantable): Grantdef grant_index_read(self, index: str, identity: IGrantable) -> Grantpublic Grant grantIndexRead(String index, IGrantable identity)public Grant GrantIndexRead(string index, IGrantable identity)func GrantIndexRead(Index *string, Identity IGrantable) Grantdeprecated#
use opensearchservice module instead

[disable-awslint:no-grants]

2 parameters

Parameters

  • indexindexindexindexIndex — The index to grant permissions for.
  • identityidentityidentityidentityIdentity — The principal.
grantIndexReadWrite(index: string, identity: IGrantable): Grantdef grant_index_read_write(self, index: str, identity: IGrantable) -> Grantpublic Grant grantIndexReadWrite(String index, IGrantable identity)public Grant GrantIndexReadWrite(string index, IGrantable identity)func GrantIndexReadWrite(Index *string, Identity IGrantable) Grantdeprecated#
use opensearchservice module instead

[disable-awslint:no-grants]

2 parameters

Parameters

  • indexindexindexindexIndex — The index to grant permissions for.
  • identityidentityidentityidentityIdentity — The principal.
grantIndexWrite(index: string, identity: IGrantable): Grantdef grant_index_write(self, index: str, identity: IGrantable) -> Grantpublic Grant grantIndexWrite(String index, IGrantable identity)public Grant GrantIndexWrite(string index, IGrantable identity)func GrantIndexWrite(Index *string, Identity IGrantable) Grantdeprecated#
use opensearchservice module instead

[disable-awslint:no-grants]

2 parameters

Parameters

  • indexindexindexindexIndex — The index to grant permissions for.
  • identityidentityidentityidentityIdentity — The principal.
grantPathRead(path: string, identity: IGrantable): Grantdef grant_path_read(self, path: str, identity: IGrantable) -> Grantpublic Grant grantPathRead(String path, IGrantable identity)public Grant GrantPathRead(string path, IGrantable identity)func GrantPathRead(Path *string, Identity IGrantable) Grantdeprecated#
use opensearchservice module instead

[disable-awslint:no-grants]

2 parameters

Parameters

  • pathpathpathpathPath — The path to grant permissions for.
  • identityidentityidentityidentityIdentity — The principal.
grantPathReadWrite(path: string, identity: IGrantable): Grantdef grant_path_read_write(self, path: str, identity: IGrantable) -> Grantpublic Grant grantPathReadWrite(String path, IGrantable identity)public Grant GrantPathReadWrite(string path, IGrantable identity)func GrantPathReadWrite(Path *string, Identity IGrantable) Grantdeprecated#
use opensearchservice module instead

[disable-awslint:no-grants]

2 parameters

Parameters

  • pathpathpathpathPath — The path to grant permissions for.
  • identityidentityidentityidentityIdentity — The principal.
grantPathWrite(path: string, identity: IGrantable): Grantdef grant_path_write(self, path: str, identity: IGrantable) -> Grantpublic Grant grantPathWrite(String path, IGrantable identity)public Grant GrantPathWrite(string path, IGrantable identity)func GrantPathWrite(Path *string, Identity IGrantable) Grantdeprecated#
use opensearchservice module instead

[disable-awslint:no-grants]

2 parameters

Parameters

  • pathpathpathpathPath — The path to grant permissions for.
  • identityidentityidentityidentityIdentity — The principal.
grantRead(identity: IGrantable): Grantdef grant_read(self, identity: IGrantable) -> Grantpublic Grant grantRead(IGrantable identity)public Grant GrantRead(IGrantable identity)func GrantRead(Identity IGrantable) Grantdeprecated#
use opensearchservice module instead

[disable-awslint:no-grants]

1 parameter

Parameters

  • identityidentityidentityidentityIdentity — The principal.
grantReadWrite(identity: IGrantable): Grantdef grant_read_write(self, identity: IGrantable) -> Grantpublic Grant grantReadWrite(IGrantable identity)public Grant GrantReadWrite(IGrantable identity)func GrantReadWrite(Identity IGrantable) Grantdeprecated#
use opensearchservice module instead

[disable-awslint:no-grants]

1 parameter

Parameters

  • identityidentityidentityidentityIdentity — The principal.
grantWrite(identity: IGrantable): Grantdef grant_write(self, identity: IGrantable) -> Grantpublic Grant grantWrite(IGrantable identity)public Grant GrantWrite(IGrantable identity)func GrantWrite(Identity IGrantable) Grantdeprecated#
use opensearchservice module instead

[disable-awslint:no-grants]

1 parameter

Parameters

  • identityidentityidentityidentityIdentity — The principal.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#
Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#
Check whether the given construct is a Resource.
metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricAutomatedSnapshotFailure(props?: MetricOptions): Metricdef metric_automated_snapshot_failure(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricAutomatedSnapshotFailure(MetricOptions props)public Metric MetricAutomatedSnapshotFailure(MetricOptions? props = null)func MetricAutomatedSnapshotFailure(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricClusterIndexWritesBlocked(props?: MetricOptions): Metricdef metric_cluster_index_writes_blocked(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricClusterIndexWritesBlocked(MetricOptions props)public Metric MetricClusterIndexWritesBlocked(MetricOptions? props = null)func MetricClusterIndexWritesBlocked(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricClusterStatusRed(props?: MetricOptions): Metricdef metric_cluster_status_red(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricClusterStatusRed(MetricOptions props)public Metric MetricClusterStatusRed(MetricOptions? props = null)func MetricClusterStatusRed(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricClusterStatusYellow(props?: MetricOptions): Metricdef metric_cluster_status_yellow(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricClusterStatusYellow(MetricOptions props)public Metric MetricClusterStatusYellow(MetricOptions? props = null)func MetricClusterStatusYellow(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricCPUUtilization(props?: MetricOptions): Metricdef metric_cpu_utilization(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricCPUUtilization(MetricOptions props)public Metric MetricCPUUtilization(MetricOptions? props = null)func MetricCPUUtilization(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricFreeStorageSpace(props?: MetricOptions): Metricdef metric_free_storage_space(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricFreeStorageSpace(MetricOptions props)public Metric MetricFreeStorageSpace(MetricOptions? props = null)func MetricFreeStorageSpace(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricIndexingLatency(props?: MetricOptions): Metricdef metric_indexing_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricIndexingLatency(MetricOptions props)public Metric MetricIndexingLatency(MetricOptions? props = null)func MetricIndexingLatency(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricJVMMemoryPressure(props?: MetricOptions): Metricdef metric_jvm_memory_pressure(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricJVMMemoryPressure(MetricOptions props)public Metric MetricJVMMemoryPressure(MetricOptions? props = null)func MetricJVMMemoryPressure(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricKMSKeyError(props?: MetricOptions): Metricdef metric_kms_key_error(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricKMSKeyError(MetricOptions props)public Metric MetricKMSKeyError(MetricOptions? props = null)func MetricKMSKeyError(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricKMSKeyInaccessible(props?: MetricOptions): Metricdef metric_kms_key_inaccessible(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricKMSKeyInaccessible(MetricOptions props)public Metric MetricKMSKeyInaccessible(MetricOptions? props = null)func MetricKMSKeyInaccessible(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricMasterCPUUtilization(props?: MetricOptions): Metricdef metric_master_cpu_utilization(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMasterCPUUtilization(MetricOptions props)public Metric MetricMasterCPUUtilization(MetricOptions? props = null)func MetricMasterCPUUtilization(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricMasterJVMMemoryPressure(props?: MetricOptions): Metricdef metric_master_jvm_memory_pressure(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMasterJVMMemoryPressure(MetricOptions props)public Metric MetricMasterJVMMemoryPressure(MetricOptions? props = null)func MetricMasterJVMMemoryPressure(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricNodes(props?: MetricOptions): Metricdef metric_nodes(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricNodes(MetricOptions props)public Metric MetricNodes(MetricOptions? props = null)func MetricNodes(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricSearchableDocuments(props?: MetricOptions): Metricdef metric_searchable_documents(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSearchableDocuments(MetricOptions props)public Metric MetricSearchableDocuments(MetricOptions? props = null)func MetricSearchableDocuments(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
metricSearchLatency(props?: MetricOptions): Metricdef metric_search_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSearchLatency(MetricOptions props)public Metric MetricSearchLatency(MetricOptions? props = null)func MetricSearchLatency(Props MetricOptions) Metricdeprecated#
use opensearchservice module instead
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.