Instaclustr Logo
Powered by Redocly

AWS Security Group Firewall Rule V2

Operations related to AWS security group firewall rule

List all security group firewall rules

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster.

Responses
200

Successfully retrieved AWS security group firewall rules.

get/cluster-management/v2/data-sources/providers/aws/aws_cluster/{clusterId}/security-group-firewall-rules/v2
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add an AWS security group firewall rule
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
securityGroupId
required
string
The security group ID of the AWS security group firewall rule.


 
clusterId
required
string <uuid> 
ID of the cluster for the AWS security group firewall rule.


 
type
required
string (FirewallRuleTypesV2) 
The type of firewall rule.


 Enum: "APACHE_ZOOKEEPER" "CADENCE" "CADENCE_GRPC" "CADENCE_HTTP_API" "CADENCE_WEB" "CASSANDRA" "CASSANDRA_CQL" "CLICKHOUSE" "CLICKHOUSE_WEB" "ELASTICSEARCH" "KAFKA" "KAFKA_CONNECT" "KAFKA_ENCRYPTION" "KAFKA_MTLS" "KAFKA_NO_ENCRYPTION" "KAFKA_PRIVATE_SASL_PLAINTEXT_LISTENER" "KAFKA_PUBLIC_SASL_PLAINTEXT_LISTENER" "KAFKA_PRIVATE_PLAINTEXT_LISTENER" "KAFKA_PUBLIC_PLAINTEXT_LISTENER" "KAFKA_PRIVATE_SSL_LISTENER" "KAFKA_PUBLIC_SSL_LISTENER" "KAFKA_REST_PROXY" "KAFKA_SCHEMA_REGISTRY" "KARAPACE_REST_PROXY" "KARAPACE_SCHEMA_REGISTRY" "OPENSEARCH" "OPENSEARCH_DASHBOARDS" "PGBOUNCER" "POSTGRESQL" "REDIS" "VALKEY" "SEARCH_DASHBOARDS" "SECURE_APACHE_ZOOKEEPER" "SPARK" "SPARK_JOBSERVER" "SHOTOVER_PROXY"  
Responses 
202
Successfully added the AWS security group firewall rule.


post/cluster-management/v2/resources/providers/aws/security-group-firewall-rules/v2
Request samples 
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "securityGroupId": "sg-01abc2345defg6789",
  • "type": "CASSANDRA"
}
Response samples 
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "securityGroupId": "sg-01abc2345defg6789",
  • "type": "CASSANDRA"
}
Get AWS security group firewall rule details
SecurityBasic Authentication 
Request 
path Parameters
firewallRuleId
required
string <uuid> 
ID of the AWS security group firewall rule.


 
Responses 
200
Retrieved the details of the AWS security group firewall rule.


404
Aws security group firewall rule not found


get/cluster-management/v2/resources/providers/aws/security-group-firewall-rules/v2/{firewallRuleId}
Request samples 
Response samples 
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "securityGroupId": "sg-01abc2345defg6789",
  • "type": "CASSANDRA"
}
Delete AWS security group firewall rule
SecurityBasic Authentication 
Request 
path Parameters
firewallRuleId
required
string <uuid> 
ID of the AWS security group firewall rule.


 
Responses 
204
Aws Security Group Firewall Rule successfully deleted.


404
Aws Security Group Firewall Rule not found


delete/cluster-management/v2/resources/providers/aws/security-group-firewall-rules/v2/{firewallRuleId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to AWS Security Group Firewall Rules V2