Class CfnDomain
The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service domain.
Inherited Members
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDomain : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDomain
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
CloudformationResource: AWS::OpenSearchService::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.OpenSearchService;
var accessPolicies;
var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
AccessPolicies = accessPolicies,
AdvancedOptions = new Dictionary<string, string> {
{ "advancedOptionsKey", "advancedOptions" }
},
AdvancedSecurityOptions = new AdvancedSecurityOptionsInputProperty {
AnonymousAuthDisableDate = "anonymousAuthDisableDate",
AnonymousAuthEnabled = false,
Enabled = false,
InternalUserDatabaseEnabled = false,
MasterUserOptions = new MasterUserOptionsProperty {
MasterUserArn = "masterUserArn",
MasterUserName = "masterUserName",
MasterUserPassword = "masterUserPassword"
},
SamlOptions = new SAMLOptionsProperty {
Enabled = false,
Idp = new IdpProperty {
EntityId = "entityId",
MetadataContent = "metadataContent"
},
MasterBackendRole = "masterBackendRole",
MasterUserName = "masterUserName",
RolesKey = "rolesKey",
SessionTimeoutMinutes = 123,
SubjectKey = "subjectKey"
}
},
ClusterConfig = new ClusterConfigProperty {
ColdStorageOptions = new ColdStorageOptionsProperty {
Enabled = false
},
DedicatedMasterCount = 123,
DedicatedMasterEnabled = false,
DedicatedMasterType = "dedicatedMasterType",
InstanceCount = 123,
InstanceType = "instanceType",
MultiAzWithStandbyEnabled = false,
WarmCount = 123,
WarmEnabled = false,
WarmType = "warmType",
ZoneAwarenessConfig = new ZoneAwarenessConfigProperty {
AvailabilityZoneCount = 123
},
ZoneAwarenessEnabled = false
},
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,
Throughput = 123,
VolumeSize = 123,
VolumeType = "volumeType"
},
EncryptionAtRestOptions = new EncryptionAtRestOptionsProperty {
Enabled = false,
KmsKeyId = "kmsKeyId"
},
EngineVersion = "engineVersion",
IpAddressType = "ipAddressType",
LogPublishingOptions = new Dictionary<string, object> {
{ "logPublishingOptionsKey", new LogPublishingOptionProperty {
CloudWatchLogsLogGroupArn = "cloudWatchLogsLogGroupArn",
Enabled = false
} }
},
NodeToNodeEncryptionOptions = new NodeToNodeEncryptionOptionsProperty {
Enabled = false
},
OffPeakWindowOptions = new OffPeakWindowOptionsProperty {
Enabled = false,
OffPeakWindow = new OffPeakWindowProperty {
WindowStartTime = new WindowStartTimeProperty {
Hours = 123,
Minutes = 123
}
}
},
SnapshotOptions = new SnapshotOptionsProperty {
AutomatedSnapshotStartHour = 123
},
SoftwareUpdateOptions = new SoftwareUpdateOptionsProperty {
AutoSoftwareUpdateEnabled = false
},
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 and SAML authentication. |
AttrAdvancedSecurityOptionsAnonymousAuthDisableDate | Date and time when the migration period will be disabled. |
AttrArn | The Amazon Resource Name (ARN) of the CloudFormation stack. |
AttrDomainEndpoint | The domain-specific endpoint used for requests to the OpenSearch APIs, such as |
AttrDomainEndpoints | |
AttrDomainEndpointV2 | If |
AttrId | The resource ID. |
AttrServiceSoftwareOptions | |
AttrServiceSoftwareOptionsAutomatedUpdateDate | |
AttrServiceSoftwareOptionsCancellable | |
AttrServiceSoftwareOptionsCurrentVersion | |
AttrServiceSoftwareOptionsDescription | |
AttrServiceSoftwareOptionsNewVersion | |
AttrServiceSoftwareOptionsOptionalDeployment | |
AttrServiceSoftwareOptionsUpdateAvailable | |
AttrServiceSoftwareOptionsUpdateStatus | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterConfig | Container for the cluster configuration of a domain. |
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. |
EncryptionAtRestOptions | Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. |
EngineVersion | The version of OpenSearch to use. |
IpAddressType | Choose either dual stack or IPv4 as your IP address type. |
LogPublishingOptions | An object with one or more of the following keys: |
NodeToNodeEncryptionOptions | Specifies whether node-to-node encryption is enabled. |
OffPeakWindowOptions | Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain. |
SnapshotOptions | DEPRECATED . |
SoftwareUpdateOptions | Service software update options for the domain. |
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 and SAML authentication.
public virtual object AdvancedSecurityOptions { get; set; }
Property Value
System.Object
AttrAdvancedSecurityOptionsAnonymousAuthDisableDate
Date and time when the migration period will be disabled.
public virtual string AttrAdvancedSecurityOptionsAnonymousAuthDisableDate { get; }
Property Value
System.String
Remarks
Only necessary when enabling fine-grained access control on an existing domain .
CloudformationAttribute: AdvancedSecurityOptions.AnonymousAuthDisableDate
AttrArn
The Amazon Resource Name (ARN) of the CloudFormation stack.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrDomainEndpoint
The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com
.
public virtual string AttrDomainEndpoint { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DomainEndpoint
AttrDomainEndpoints
public virtual IResolvable AttrDomainEndpoints { get; }
Property Value
Remarks
CloudformationAttribute: DomainEndpoints
AttrDomainEndpointV2
If IPAddressType
to set to dualstack
, a version 2 domain endpoint is provisioned.
public virtual string AttrDomainEndpointV2 { get; }
Property Value
System.String
Remarks
This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.
CloudformationAttribute: DomainEndpointV2
AttrId
The resource ID.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
For example, 123456789012/my-domain
.
CloudformationAttribute: Id
AttrServiceSoftwareOptions
public virtual IResolvable AttrServiceSoftwareOptions { get; }
Property Value
Remarks
CloudformationAttribute: ServiceSoftwareOptions
AttrServiceSoftwareOptionsAutomatedUpdateDate
public virtual string AttrServiceSoftwareOptionsAutomatedUpdateDate { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ServiceSoftwareOptions.AutomatedUpdateDate
AttrServiceSoftwareOptionsCancellable
public virtual IResolvable AttrServiceSoftwareOptionsCancellable { get; }
Property Value
Remarks
CloudformationAttribute: ServiceSoftwareOptions.Cancellable
AttrServiceSoftwareOptionsCurrentVersion
public virtual string AttrServiceSoftwareOptionsCurrentVersion { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ServiceSoftwareOptions.CurrentVersion
AttrServiceSoftwareOptionsDescription
public virtual string AttrServiceSoftwareOptionsDescription { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ServiceSoftwareOptions.Description
AttrServiceSoftwareOptionsNewVersion
public virtual string AttrServiceSoftwareOptionsNewVersion { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ServiceSoftwareOptions.NewVersion
AttrServiceSoftwareOptionsOptionalDeployment
public virtual IResolvable AttrServiceSoftwareOptionsOptionalDeployment { get; }
Property Value
Remarks
CloudformationAttribute: ServiceSoftwareOptions.OptionalDeployment
AttrServiceSoftwareOptionsUpdateAvailable
public virtual IResolvable AttrServiceSoftwareOptionsUpdateAvailable { get; }
Property Value
Remarks
CloudformationAttribute: ServiceSoftwareOptions.UpdateAvailable
AttrServiceSoftwareOptionsUpdateStatus
public virtual string AttrServiceSoftwareOptionsUpdateStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ServiceSoftwareOptions.UpdateStatus
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
ClusterConfig
Container for the cluster configuration of a domain.
public virtual object ClusterConfig { get; set; }
Property Value
System.Object
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
EncryptionAtRestOptions
Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.
public virtual object EncryptionAtRestOptions { get; set; }
Property Value
System.Object
EngineVersion
The version of OpenSearch to use.
public virtual string EngineVersion { get; set; }
Property Value
System.String
IpAddressType
Choose either dual stack or IPv4 as your IP address type.
public virtual string IpAddressType { get; set; }
Property Value
System.String
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
OffPeakWindowOptions
Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
public virtual object OffPeakWindowOptions { get; set; }
Property Value
System.Object
SnapshotOptions
DEPRECATED .
public virtual object SnapshotOptions { get; set; }
Property Value
System.Object
SoftwareUpdateOptions
Service software update options for the domain.
public virtual object SoftwareUpdateOptions { 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>