Optional ReadonlyappLog group that application logs are logged to.
Optional ReadonlyauditLog group that audit logs are logged to.
ReadonlydomainReadonlydomainReadonlydomainReadonlydomainReadonlyenvThe environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
Optional ReadonlymasterMaster user password if fine grained access control is configured.
ReadonlynodeThe tree node.
Protected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationOptional ReadonlyslowLog group that slow indices are logged to.
Optional ReadonlyslowLog group that slow searches are logged to.
ReadonlystackThe stack in which this resource is defined.
Static ReadonlyPROPERTY_Uniquely identifies this class.
Manages network connections to the domain. This will throw an error in case the domain is not placed inside a VPC.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
Add policy statements to the domain access policy
Apply the given removal policy to this resource
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).
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
The index to grant permissions for
The principal
Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).
The index to grant permissions for
The principal
Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).
The index to grant permissions for
The principal
Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).
The path to grant permissions for
The principal
Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
The path to grant permissions for
The principal
Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
The path to grant permissions for
The principal
Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).
The principal
Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).
The principal
Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).
The principal
Return the given named metric for this domain.
Optionalprops: MetricOptionsReturns a string representation of this construct.
StaticfromCreates a domain construct that represents an external domain.
The parent creating construct (usually this).
The construct's name.
A DomainAttributes object.
StaticfromCreates a domain construct that represents an external domain via domain endpoint.
The parent creating construct (usually this).
The construct's name.
The domain's endpoint.
StaticisChecks if x is a construct.
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.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
A construct for the creation of a compliant Opensearch Domain Specifically, the construct ensures the following: