Bicep resource definition
The daxClusters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AwsConnector/daxClusters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AwsConnector/daxClusters@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
activeNodes: int
clusterArn: 'string'
clusterDiscoveryEndpoint: {
address: 'string'
port: int
url: 'string'
}
clusterEndpointEncryptionType: {
value: 'string'
}
clusterName: 'string'
description: 'string'
iamRoleArn: 'string'
nodeIdsToRemove: [
'string'
]
nodes: [
{
availabilityZone: 'string'
endpoint: {
address: 'string'
port: int
url: 'string'
}
nodeCreateTime: 'string'
nodeId: 'string'
nodeStatus: 'string'
parameterGroupStatus: 'string'
}
]
nodeType: 'string'
notificationConfiguration: {
topicArn: 'string'
topicStatus: 'string'
}
parameterGroup: {
nodeIdsToReboot: [
'string'
]
parameterApplyStatus: 'string'
parameterGroupName: 'string'
}
preferredMaintenanceWindow: 'string'
securityGroups: [
{
securityGroupIdentifier: 'string'
status: 'string'
}
]
sseDescription: {
status: {
value: 'string'
}
}
status: 'string'
subnetGroup: 'string'
totalNodes: int
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AwsConnector/daxClusters
Name |
Description |
Value |
location |
The geo-location where the resource lives |
string (required) |
name |
The resource name |
string
Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
properties |
The resource-specific properties for this resource. |
DaxClusterProperties |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
AwsDaxClusterProperties
Name |
Description |
Value |
activeNodes |
<p>The number of nodes in the cluster that are active (i.e., capable of serving requests).</p> |
int |
clusterArn |
<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster. </p> |
string |
clusterDiscoveryEndpoint |
<p>The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.</p> |
Endpoint |
clusterEndpointEncryptionType |
<p>The type of encryption supported by the cluster's endpoint. Values are:</p> <ul> <li> <p> <code>NONE</code> for no encryption</p> <p> <code>TLS</code> for Transport Layer Security</p> </li> </ul> |
ClusterEndpointEncryptionTypeEnumValue |
clusterName |
<p>The name of the DAX cluster.</p> |
string |
description |
<p>The description of the cluster.</p> |
string |
iamRoleArn |
<p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.</p> |
string |
nodeIdsToRemove |
<p>A list of nodes to be removed from the cluster.</p> |
string[] |
nodes |
<p>A list of nodes that are currently in the cluster.</p> |
Node[] |
nodeType |
<p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)</p> |
string |
notificationConfiguration |
<p>Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).</p> |
NotificationConfigurationAutoGenerated |
parameterGroup |
<p>The parameter group being used by nodes in the cluster.</p> |
ParameterGroupStatus |
preferredMaintenanceWindow |
<p>A range of time when maintenance of DAX cluster software will be performed. For example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.</p> |
string |
securityGroups |
<p>A list of security groups, and the status of each, for the nodes in the cluster.</p> |
SecurityGroupMembership[] |
sseDescription |
<p>The description of the server-side encryption status on the specified DAX cluster.</p> |
SSEDescription |
status |
<p>The current status of the cluster.</p> |
string |
subnetGroup |
<p>The subnet group where the DAX cluster is running.</p> |
string |
totalNodes |
<p>The total number of nodes in the cluster.</p> |
int |
ClusterEndpointEncryptionTypeEnumValue
Name |
Description |
Value |
value |
Property value |
'NONE' 'TLS' |
DaxClusterProperties
Name |
Description |
Value |
arn |
Amazon Resource Name (ARN) |
string |
awsAccountId |
AWS Account ID |
string |
awsProperties |
AWS Properties |
AwsDaxClusterProperties |
awsRegion |
AWS Region |
string |
awsSourceSchema |
AWS Source Schema |
string |
awsTags |
AWS Tags |
DaxClusterPropertiesAwsTags |
publicCloudConnectorsResourceId |
Public Cloud Connectors Resource ID |
string |
publicCloudResourceName |
Public Cloud Resource Name |
string |
Endpoint
Name |
Description |
Value |
address |
<p>The DNS hostname of the endpoint.</p> |
string |
port |
<p>The port number that applications should use to connect to the endpoint.</p> |
int |
url |
<p>The URL that applications should use to connect to the endpoint. The default ports are 8111 for the 'dax' protocol and 9111 for the 'daxs' protocol.</p> |
string |
Node
Name |
Description |
Value |
availabilityZone |
<p>The Availability Zone (AZ) in which the node has been deployed.</p> |
string |
endpoint |
<p>The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.</p> |
Endpoint |
nodeCreateTime |
<p>The date and time (in UNIX epoch format) when the node was launched.</p> |
string |
nodeId |
<p>A system-generated identifier for the node.</p> |
string |
nodeStatus |
<p>The current status of the node. For example: <code>available</code>.</p> |
string |
parameterGroupStatus |
<p>The status of the parameter group associated with this node. For example, <code>in-sync</code>.</p> |
string |
NotificationConfigurationAutoGenerated
Name |
Description |
Value |
topicArn |
<p>The Amazon Resource Name (ARN) that identifies the topic. </p> |
string |
topicStatus |
<p>The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.</p> |
string |
ParameterGroupStatus
Name |
Description |
Value |
nodeIdsToReboot |
<p>The node IDs of one or more nodes to be rebooted.</p> |
string[] |
parameterApplyStatus |
<p>The status of parameter updates. </p> |
string |
parameterGroupName |
<p>The name of the parameter group.</p> |
string |
SecurityGroupMembership
Name |
Description |
Value |
securityGroupIdentifier |
<p>The unique ID for this security group.</p> |
string |
status |
<p>The status of this security group.</p> |
string |
SSEDescription
Name |
Description |
Value |
status |
<p>The current state of server-side encryption:</p> <ul> <li> <p> <code>ENABLING</code> - Server-side encryption is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Server-side encryption is enabled.</p> </li> <li> <p> <code>DISABLING</code> - Server-side encryption is being disabled.</p> </li> <li> <p> <code>DISABLED</code> - Server-side encryption is disabled.</p> </li> </ul> |
SSEStatusEnumValue |
SSEStatusEnumValue
Name |
Description |
Value |
value |
Property value |
'DISABLED' 'DISABLING' 'ENABLED' 'ENABLING' |
ARM template resource definition
The daxClusters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AwsConnector/daxClusters resource, add the following JSON to your template.
{
"type": "Microsoft.AwsConnector/daxClusters",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"activeNodes": "int",
"clusterArn": "string",
"clusterDiscoveryEndpoint": {
"address": "string",
"port": "int",
"url": "string"
},
"clusterEndpointEncryptionType": {
"value": "string"
},
"clusterName": "string",
"description": "string",
"iamRoleArn": "string",
"nodeIdsToRemove": [ "string" ],
"nodes": [
{
"availabilityZone": "string",
"endpoint": {
"address": "string",
"port": "int",
"url": "string"
},
"nodeCreateTime": "string",
"nodeId": "string",
"nodeStatus": "string",
"parameterGroupStatus": "string"
}
],
"nodeType": "string",
"notificationConfiguration": {
"topicArn": "string",
"topicStatus": "string"
},
"parameterGroup": {
"nodeIdsToReboot": [ "string" ],
"parameterApplyStatus": "string",
"parameterGroupName": "string"
},
"preferredMaintenanceWindow": "string",
"securityGroups": [
{
"securityGroupIdentifier": "string",
"status": "string"
}
],
"sseDescription": {
"status": {
"value": "string"
}
},
"status": "string",
"subnetGroup": "string",
"totalNodes": "int"
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AwsConnector/daxClusters
Name |
Description |
Value |
apiVersion |
The api version |
'2024-12-01' |
location |
The geo-location where the resource lives |
string (required) |
name |
The resource name |
string
Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
properties |
The resource-specific properties for this resource. |
DaxClusterProperties |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
type |
The resource type |
'Microsoft.AwsConnector/daxClusters' |
AwsDaxClusterProperties
Name |
Description |
Value |
activeNodes |
<p>The number of nodes in the cluster that are active (i.e., capable of serving requests).</p> |
int |
clusterArn |
<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster. </p> |
string |
clusterDiscoveryEndpoint |
<p>The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.</p> |
Endpoint |
clusterEndpointEncryptionType |
<p>The type of encryption supported by the cluster's endpoint. Values are:</p> <ul> <li> <p> <code>NONE</code> for no encryption</p> <p> <code>TLS</code> for Transport Layer Security</p> </li> </ul> |
ClusterEndpointEncryptionTypeEnumValue |
clusterName |
<p>The name of the DAX cluster.</p> |
string |
description |
<p>The description of the cluster.</p> |
string |
iamRoleArn |
<p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.</p> |
string |
nodeIdsToRemove |
<p>A list of nodes to be removed from the cluster.</p> |
string[] |
nodes |
<p>A list of nodes that are currently in the cluster.</p> |
Node[] |
nodeType |
<p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)</p> |
string |
notificationConfiguration |
<p>Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).</p> |
NotificationConfigurationAutoGenerated |
parameterGroup |
<p>The parameter group being used by nodes in the cluster.</p> |
ParameterGroupStatus |
preferredMaintenanceWindow |
<p>A range of time when maintenance of DAX cluster software will be performed. For example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.</p> |
string |
securityGroups |
<p>A list of security groups, and the status of each, for the nodes in the cluster.</p> |
SecurityGroupMembership[] |
sseDescription |
<p>The description of the server-side encryption status on the specified DAX cluster.</p> |
SSEDescription |
status |
<p>The current status of the cluster.</p> |
string |
subnetGroup |
<p>The subnet group where the DAX cluster is running.</p> |
string |
totalNodes |
<p>The total number of nodes in the cluster.</p> |
int |
ClusterEndpointEncryptionTypeEnumValue
Name |
Description |
Value |
value |
Property value |
'NONE' 'TLS' |
DaxClusterProperties
Name |
Description |
Value |
arn |
Amazon Resource Name (ARN) |
string |
awsAccountId |
AWS Account ID |
string |
awsProperties |
AWS Properties |
AwsDaxClusterProperties |
awsRegion |
AWS Region |
string |
awsSourceSchema |
AWS Source Schema |
string |
awsTags |
AWS Tags |
DaxClusterPropertiesAwsTags |
publicCloudConnectorsResourceId |
Public Cloud Connectors Resource ID |
string |
publicCloudResourceName |
Public Cloud Resource Name |
string |
Endpoint
Name |
Description |
Value |
address |
<p>The DNS hostname of the endpoint.</p> |
string |
port |
<p>The port number that applications should use to connect to the endpoint.</p> |
int |
url |
<p>The URL that applications should use to connect to the endpoint. The default ports are 8111 for the 'dax' protocol and 9111 for the 'daxs' protocol.</p> |
string |
Node
Name |
Description |
Value |
availabilityZone |
<p>The Availability Zone (AZ) in which the node has been deployed.</p> |
string |
endpoint |
<p>The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.</p> |
Endpoint |
nodeCreateTime |
<p>The date and time (in UNIX epoch format) when the node was launched.</p> |
string |
nodeId |
<p>A system-generated identifier for the node.</p> |
string |
nodeStatus |
<p>The current status of the node. For example: <code>available</code>.</p> |
string |
parameterGroupStatus |
<p>The status of the parameter group associated with this node. For example, <code>in-sync</code>.</p> |
string |
NotificationConfigurationAutoGenerated
Name |
Description |
Value |
topicArn |
<p>The Amazon Resource Name (ARN) that identifies the topic. </p> |
string |
topicStatus |
<p>The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.</p> |
string |
ParameterGroupStatus
Name |
Description |
Value |
nodeIdsToReboot |
<p>The node IDs of one or more nodes to be rebooted.</p> |
string[] |
parameterApplyStatus |
<p>The status of parameter updates. </p> |
string |
parameterGroupName |
<p>The name of the parameter group.</p> |
string |
SecurityGroupMembership
Name |
Description |
Value |
securityGroupIdentifier |
<p>The unique ID for this security group.</p> |
string |
status |
<p>The status of this security group.</p> |
string |
SSEDescription
Name |
Description |
Value |
status |
<p>The current state of server-side encryption:</p> <ul> <li> <p> <code>ENABLING</code> - Server-side encryption is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Server-side encryption is enabled.</p> </li> <li> <p> <code>DISABLING</code> - Server-side encryption is being disabled.</p> </li> <li> <p> <code>DISABLED</code> - Server-side encryption is disabled.</p> </li> </ul> |
SSEStatusEnumValue |
SSEStatusEnumValue
Name |
Description |
Value |
value |
Property value |
'DISABLED' 'DISABLING' 'ENABLED' 'ENABLING' |
Usage Examples
The daxClusters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AwsConnector/daxClusters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/daxClusters@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
activeNodes = int
clusterArn = "string"
clusterDiscoveryEndpoint = {
address = "string"
port = int
url = "string"
}
clusterEndpointEncryptionType = {
value = "string"
}
clusterName = "string"
description = "string"
iamRoleArn = "string"
nodeIdsToRemove = [
"string"
]
nodes = [
{
availabilityZone = "string"
endpoint = {
address = "string"
port = int
url = "string"
}
nodeCreateTime = "string"
nodeId = "string"
nodeStatus = "string"
parameterGroupStatus = "string"
}
]
nodeType = "string"
notificationConfiguration = {
topicArn = "string"
topicStatus = "string"
}
parameterGroup = {
nodeIdsToReboot = [
"string"
]
parameterApplyStatus = "string"
parameterGroupName = "string"
}
preferredMaintenanceWindow = "string"
securityGroups = [
{
securityGroupIdentifier = "string"
status = "string"
}
]
sseDescription = {
status = {
value = "string"
}
}
status = "string"
subnetGroup = "string"
totalNodes = int
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
Property Values
Microsoft.AwsConnector/daxClusters
Name |
Description |
Value |
location |
The geo-location where the resource lives |
string (required) |
name |
The resource name |
string
Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
properties |
The resource-specific properties for this resource. |
DaxClusterProperties |
tags |
Resource tags |
Dictionary of tag names and values. |
type |
The resource type |
"Microsoft.AwsConnector/daxClusters@2024-12-01" |
AwsDaxClusterProperties
Name |
Description |
Value |
activeNodes |
<p>The number of nodes in the cluster that are active (i.e., capable of serving requests).</p> |
int |
clusterArn |
<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster. </p> |
string |
clusterDiscoveryEndpoint |
<p>The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.</p> |
Endpoint |
clusterEndpointEncryptionType |
<p>The type of encryption supported by the cluster's endpoint. Values are:</p> <ul> <li> <p> <code>NONE</code> for no encryption</p> <p> <code>TLS</code> for Transport Layer Security</p> </li> </ul> |
ClusterEndpointEncryptionTypeEnumValue |
clusterName |
<p>The name of the DAX cluster.</p> |
string |
description |
<p>The description of the cluster.</p> |
string |
iamRoleArn |
<p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.</p> |
string |
nodeIdsToRemove |
<p>A list of nodes to be removed from the cluster.</p> |
string[] |
nodes |
<p>A list of nodes that are currently in the cluster.</p> |
Node[] |
nodeType |
<p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)</p> |
string |
notificationConfiguration |
<p>Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).</p> |
NotificationConfigurationAutoGenerated |
parameterGroup |
<p>The parameter group being used by nodes in the cluster.</p> |
ParameterGroupStatus |
preferredMaintenanceWindow |
<p>A range of time when maintenance of DAX cluster software will be performed. For example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.</p> |
string |
securityGroups |
<p>A list of security groups, and the status of each, for the nodes in the cluster.</p> |
SecurityGroupMembership[] |
sseDescription |
<p>The description of the server-side encryption status on the specified DAX cluster.</p> |
SSEDescription |
status |
<p>The current status of the cluster.</p> |
string |
subnetGroup |
<p>The subnet group where the DAX cluster is running.</p> |
string |
totalNodes |
<p>The total number of nodes in the cluster.</p> |
int |
ClusterEndpointEncryptionTypeEnumValue
Name |
Description |
Value |
value |
Property value |
'NONE' 'TLS' |
DaxClusterProperties
Name |
Description |
Value |
arn |
Amazon Resource Name (ARN) |
string |
awsAccountId |
AWS Account ID |
string |
awsProperties |
AWS Properties |
AwsDaxClusterProperties |
awsRegion |
AWS Region |
string |
awsSourceSchema |
AWS Source Schema |
string |
awsTags |
AWS Tags |
DaxClusterPropertiesAwsTags |
publicCloudConnectorsResourceId |
Public Cloud Connectors Resource ID |
string |
publicCloudResourceName |
Public Cloud Resource Name |
string |
Endpoint
Name |
Description |
Value |
address |
<p>The DNS hostname of the endpoint.</p> |
string |
port |
<p>The port number that applications should use to connect to the endpoint.</p> |
int |
url |
<p>The URL that applications should use to connect to the endpoint. The default ports are 8111 for the 'dax' protocol and 9111 for the 'daxs' protocol.</p> |
string |
Node
Name |
Description |
Value |
availabilityZone |
<p>The Availability Zone (AZ) in which the node has been deployed.</p> |
string |
endpoint |
<p>The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.</p> |
Endpoint |
nodeCreateTime |
<p>The date and time (in UNIX epoch format) when the node was launched.</p> |
string |
nodeId |
<p>A system-generated identifier for the node.</p> |
string |
nodeStatus |
<p>The current status of the node. For example: <code>available</code>.</p> |
string |
parameterGroupStatus |
<p>The status of the parameter group associated with this node. For example, <code>in-sync</code>.</p> |
string |
NotificationConfigurationAutoGenerated
Name |
Description |
Value |
topicArn |
<p>The Amazon Resource Name (ARN) that identifies the topic. </p> |
string |
topicStatus |
<p>The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.</p> |
string |
ParameterGroupStatus
Name |
Description |
Value |
nodeIdsToReboot |
<p>The node IDs of one or more nodes to be rebooted.</p> |
string[] |
parameterApplyStatus |
<p>The status of parameter updates. </p> |
string |
parameterGroupName |
<p>The name of the parameter group.</p> |
string |
SecurityGroupMembership
Name |
Description |
Value |
securityGroupIdentifier |
<p>The unique ID for this security group.</p> |
string |
status |
<p>The status of this security group.</p> |
string |
SSEDescription
Name |
Description |
Value |
status |
<p>The current state of server-side encryption:</p> <ul> <li> <p> <code>ENABLING</code> - Server-side encryption is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Server-side encryption is enabled.</p> </li> <li> <p> <code>DISABLING</code> - Server-side encryption is being disabled.</p> </li> <li> <p> <code>DISABLED</code> - Server-side encryption is disabled.</p> </li> </ul> |
SSEStatusEnumValue |
SSEStatusEnumValue
Name |
Description |
Value |
value |
Property value |
'DISABLED' 'DISABLING' 'ENABLED' 'ENABLING' |