Class CfnDomain
The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.
Inherited Members
Namespace: Amazon.CDK.AWS.Elasticsearch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDomain : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDomain
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
The AWS::Elasticsearch::Domain
resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see Remarks .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html
CloudformationResource: AWS::Elasticsearch::Domain
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Elasticsearch;
var accessPolicies;
var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
AccessPolicies = accessPolicies,
AdvancedOptions = new Dictionary<string, string> {
{ "advancedOptionsKey", "advancedOptions" }
},
AdvancedSecurityOptions = new AdvancedSecurityOptionsInputProperty {
AnonymousAuthEnabled = false,
Enabled = false,
InternalUserDatabaseEnabled = false,
MasterUserOptions = new MasterUserOptionsProperty {
MasterUserArn = "masterUserArn",
MasterUserName = "masterUserName",
MasterUserPassword = "masterUserPassword"
}
},
CognitoOptions = new CognitoOptionsProperty {
Enabled = false,
IdentityPoolId = "identityPoolId",
RoleArn = "roleArn",
UserPoolId = "userPoolId"
},
DomainArn = "domainArn",
DomainEndpointOptions = new DomainEndpointOptionsProperty {
CustomEndpoint = "customEndpoint",
CustomEndpointCertificateArn = "customEndpointCertificateArn",
CustomEndpointEnabled = false,
EnforceHttps = false,
TlsSecurityPolicy = "tlsSecurityPolicy"
},
DomainName = "domainName",
EbsOptions = new EBSOptionsProperty {
EbsEnabled = false,
Iops = 123,
VolumeSize = 123,
VolumeType = "volumeType"
},
ElasticsearchClusterConfig = new ElasticsearchClusterConfigProperty {
ColdStorageOptions = new ColdStorageOptionsProperty {
Enabled = false
},
DedicatedMasterCount = 123,
DedicatedMasterEnabled = false,
DedicatedMasterType = "dedicatedMasterType",
InstanceCount = 123,
InstanceType = "instanceType",
WarmCount = 123,
WarmEnabled = false,
WarmType = "warmType",
ZoneAwarenessConfig = new ZoneAwarenessConfigProperty {
AvailabilityZoneCount = 123
},
ZoneAwarenessEnabled = false
},
ElasticsearchVersion = "elasticsearchVersion",
EncryptionAtRestOptions = new EncryptionAtRestOptionsProperty {
Enabled = false,
KmsKeyId = "kmsKeyId"
},
LogPublishingOptions = new Dictionary<string, object> {
{ "logPublishingOptionsKey", new LogPublishingOptionProperty {
CloudWatchLogsLogGroupArn = "cloudWatchLogsLogGroupArn",
Enabled = false
} }
},
NodeToNodeEncryptionOptions = new NodeToNodeEncryptionOptionsProperty {
Enabled = false
},
SnapshotOptions = new SnapshotOptionsProperty {
AutomatedSnapshotStartHour = 123
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcOptions = new VPCOptionsProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
});
Synopsis
Constructors
CfnDomain(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDomain(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDomain(Construct, String, ICfnDomainProps) |
Properties
AccessPolicies | An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions. |
AdvancedOptions | Additional options to specify for the OpenSearch Service domain. |
AdvancedSecurityOptions | Specifies options for fine-grained access control. |
AttrArn | The Amazon Resource Name (ARN) of the domain, such as |
AttrDomainEndpoint | The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as |
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CognitoOptions | Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. |
DomainArn | |
DomainEndpointOptions | Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint. |
DomainName | A name for the OpenSearch Service domain. |
EbsOptions | The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. |
ElasticsearchClusterConfig | ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain. |
ElasticsearchVersion | The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide . |
EncryptionAtRestOptions | Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use. |
LogPublishingOptions | An object with one or more of the following keys: |
NodeToNodeEncryptionOptions | Specifies whether node-to-node encryption is enabled. |
SnapshotOptions | DEPRECATED . |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain. |
VpcOptions | The virtual private cloud (VPC) configuration for the OpenSearch Service domain. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDomain(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDomain(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDomain(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDomain(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDomain(Construct, String, ICfnDomainProps)
public CfnDomain(Construct scope, string id, ICfnDomainProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDomainProps
Resource properties.
Properties
AccessPolicies
An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
public virtual object AccessPolicies { get; set; }
Property Value
System.Object
AdvancedOptions
Additional options to specify for the OpenSearch Service domain.
public virtual object AdvancedOptions { get; set; }
Property Value
System.Object
AdvancedSecurityOptions
Specifies options for fine-grained access control.
public virtual object AdvancedSecurityOptions { get; set; }
Property Value
System.Object
AttrArn
The Amazon Resource Name (ARN) of the domain, such as arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
This returned value is the same as the one returned by AWS::Elasticsearch::Domain.DomainArn
.
CloudformationAttribute: Arn
AttrDomainEndpoint
The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com
.
public virtual string AttrDomainEndpoint { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DomainEndpoint
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CognitoOptions
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
public virtual object CognitoOptions { get; set; }
Property Value
System.Object
DomainArn
public virtual string DomainArn { get; set; }
Property Value
System.String
DomainEndpointOptions
Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
public virtual object DomainEndpointOptions { get; set; }
Property Value
System.Object
DomainName
A name for the OpenSearch Service domain.
public virtual string DomainName { get; set; }
Property Value
System.String
EbsOptions
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
public virtual object EbsOptions { get; set; }
Property Value
System.Object
ElasticsearchClusterConfig
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
public virtual object ElasticsearchClusterConfig { get; set; }
Property Value
System.Object
ElasticsearchVersion
The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide .
public virtual string ElasticsearchVersion { get; set; }
Property Value
System.String
EncryptionAtRestOptions
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
public virtual object EncryptionAtRestOptions { get; set; }
Property Value
System.Object
LogPublishingOptions
An object with one or more of the following keys: SEARCH_SLOW_LOGS
, ES_APPLICATION_LOGS
, INDEX_SLOW_LOGS
, AUDIT_LOGS
, depending on the types of logs you want to publish.
public virtual object LogPublishingOptions { get; set; }
Property Value
System.Object
NodeToNodeEncryptionOptions
Specifies whether node-to-node encryption is enabled.
public virtual object NodeToNodeEncryptionOptions { get; set; }
Property Value
System.Object
SnapshotOptions
DEPRECATED .
public virtual object SnapshotOptions { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
VpcOptions
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
public virtual object VpcOptions { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>