ClusterPolicy class
Resource for managing an Amazon Aurora DSQL Cluster resource-based policy.
> Aurora DSQL resource-based policies can grant access to principals within the same AWS account as the cluster. Cross-account access is not currently supported by Aurora DSQL resource-based policies.
> Aurora DSQL resource-based policy changes are eventually consistent and typically take effect within one minute.
Example Usage
Block Public Internet Access
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.dsql.Cluster("example", {});
const exampleClusterPolicy = new aws.dsql.ClusterPolicy("example", {
identifier: example.identifier,
policy: JSON.stringify({
Version: "2012-10-17",
Statement: [{
Sid: "DenyAccessFromOutsideVPC",
Effect: "Deny",
Principal: {
AWS: "*",
},
Action: [
"dsql:DbConnect",
"dsql:DbConnectAdmin",
],
Resource: "*",
Condition: {
Null: {
"aws:SourceVpc": "true",
},
},
}],
}),
});
import pulumi
import json
import pulumi_aws as aws
example = aws.dsql.Cluster("example")
example_cluster_policy = aws.dsql.ClusterPolicy("example",
identifier=example.identifier,
policy=json.dumps({
"Version": "2012-10-17",
"Statement": [{
"Sid": "DenyAccessFromOutsideVPC",
"Effect": "Deny",
"Principal": {
"AWS": "*",
},
"Action": [
"dsql:DbConnect",
"dsql:DbConnectAdmin",
],
"Resource": "*",
"Condition": {
"Null": {
"aws:SourceVpc": "true",
},
},
}],
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Dsql.Cluster("example");
var exampleClusterPolicy = new Aws.Dsql.ClusterPolicy("example", new()
{
Identifier = example.Identifier,
Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Version"] = "2012-10-17",
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Sid"] = "DenyAccessFromOutsideVPC",
["Effect"] = "Deny",
["Principal"] = new Dictionary<string, object?>
{
["AWS"] = "*",
},
["Action"] = new[]
{
"dsql:DbConnect",
"dsql:DbConnectAdmin",
},
["Resource"] = "*",
["Condition"] = new Dictionary<string, object?>
{
["Null"] = new Dictionary<string, object?>
{
["aws:SourceVpc"] = "true",
},
},
},
},
}),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/dsql"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := dsql.NewCluster(ctx, "example", nil)
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Version": "2012-10-17",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Sid": "DenyAccessFromOutsideVPC",
"Effect": "Deny",
"Principal": map[string]string{
"AWS": "*",
},
"Action": []string{
"dsql:DbConnect",
"dsql:DbConnectAdmin",
},
"Resource": "*",
"Condition": map[string]map[string]string{
"Null": map[string]string{
"aws:SourceVpc": "true",
},
},
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = dsql.NewClusterPolicy(ctx, "example", &dsql.ClusterPolicyArgs{
Identifier: example.Identifier,
Policy: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_dsql_cluster" "example" {
}
resource "aws_dsql_clusterpolicy" "example" {
identifier = aws_dsql_cluster.example.identifier
policy = jsonencode({
"Version" = "2012-10-17"
"Statement" = [{
"Sid" = "DenyAccessFromOutsideVPC"
"Effect" = "Deny"
"Principal" = {
"AWS" = "*"
}
"Action" = ["dsql:DbConnect", "dsql:DbConnectAdmin"]
"Resource" = "*"
"Condition" = {
"Null" = {
"aws:SourceVpc" = "true"
}
}
}]
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dsql.Cluster;
import com.pulumi.aws.dsql.ClusterPolicy;
import com.pulumi.aws.dsql.ClusterPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Cluster("example");
var exampleClusterPolicy = new ClusterPolicy("exampleClusterPolicy", ClusterPolicyArgs.builder()
.identifier(example.identifier())
.policy(serializeJson(
jsonObject(
jsonProperty("Version", "2012-10-17"),
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Sid", "DenyAccessFromOutsideVPC"),
jsonProperty("Effect", "Deny"),
jsonProperty("Principal", jsonObject(
jsonProperty("AWS", "*")
)),
jsonProperty("Action", jsonArray(
"dsql:DbConnect",
"dsql:DbConnectAdmin"
)),
jsonProperty("Resource", "*"),
jsonProperty("Condition", jsonObject(
jsonProperty("Null", jsonObject(
jsonProperty("aws:SourceVpc", "true")
))
))
)))
)))
.build());
}
}
resources:
example:
type: aws:dsql:Cluster
exampleClusterPolicy:
type: aws:dsql:ClusterPolicy
name: example
properties:
identifier: ${example.identifier}
policy:
fn::toJSON:
Version: 2012-10-17
Statement:
- Sid: DenyAccessFromOutsideVPC
Effect: Deny
Principal:
AWS: '*'
Action:
- dsql:DbConnect
- dsql:DbConnectAdmin
Resource: '*'
Condition:
Null:
aws:SourceVpc: 'true'
This policy denies dsql:DbConnect and dsql:DbConnectAdmin requests from the public internet. It only checks whether the request came from a VPC. To limit access to a specific VPC, use aws:SourceVpc with StringNotEquals.
The calling principal still requires an identity-based IAM policy that allows the required Aurora DSQL actions on the cluster.
Restrict Access to a Specific VPC
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.dsql.Cluster("example", {});
const exampleClusterPolicy = new aws.dsql.ClusterPolicy("example", {
identifier: example.identifier,
policy: pulumi.jsonStringify({
Version: "2012-10-17",
Statement: [{
Sid: "DenyAccessFromOtherVPCs",
Effect: "Deny",
Principal: {
AWS: "*",
},
Action: [
"dsql:DbConnect",
"dsql:DbConnectAdmin",
],
Resource: example.arn,
Condition: {
StringNotEquals: {
"aws:SourceVpc": exampleAwsVpc.id,
},
},
}],
}),
});
import pulumi
import json
import pulumi_aws as aws
example = aws.dsql.Cluster("example")
example_cluster_policy = aws.dsql.ClusterPolicy("example",
identifier=example.identifier,
policy=pulumi.Output.json_dumps({
"Version": "2012-10-17",
"Statement": [{
"Sid": "DenyAccessFromOtherVPCs",
"Effect": "Deny",
"Principal": {
"AWS": "*",
},
"Action": [
"dsql:DbConnect",
"dsql:DbConnectAdmin",
],
"Resource": example.arn,
"Condition": {
"StringNotEquals": {
"aws:SourceVpc": example_aws_vpc["id"],
},
},
}],
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Dsql.Cluster("example");
var exampleClusterPolicy = new Aws.Dsql.ClusterPolicy("example", new()
{
Identifier = example.Identifier,
Policy = Output.JsonSerialize(Output.Create(new Dictionary<string, object?>
{
["Version"] = "2012-10-17",
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Sid"] = "DenyAccessFromOtherVPCs",
["Effect"] = "Deny",
["Principal"] = new Dictionary<string, object?>
{
["AWS"] = "*",
},
["Action"] = new[]
{
"dsql:DbConnect",
"dsql:DbConnectAdmin",
},
["Resource"] = example.Arn,
["Condition"] = new Dictionary<string, object?>
{
["StringNotEquals"] = new Dictionary<string, object?>
{
["aws:SourceVpc"] = exampleAwsVpc.Id,
},
},
},
},
})),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/dsql"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := dsql.NewCluster(ctx, "example", nil)
if err != nil {
return err
}
_, err = dsql.NewClusterPolicy(ctx, "example", &dsql.ClusterPolicyArgs{
Identifier: example.Identifier,
Policy: example.Arn.ApplyT(func(arn string) (pulumi.String, error) {
var _zero pulumi.String
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Version": "2012-10-17",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Sid": "DenyAccessFromOtherVPCs",
"Effect": "Deny",
"Principal": map[string]string{
"AWS": "*",
},
"Action": []string{
"dsql:DbConnect",
"dsql:DbConnectAdmin",
},
"Resource": arn,
"Condition": map[string]map[string]interface{}{
"StringNotEquals": map[string]interface{}{
"aws:SourceVpc": exampleAwsVpc.Id,
},
},
},
},
})
if err != nil {
return _zero, err
}
json0 := string(tmpJSON0)
return pulumi.String(json0), nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_dsql_cluster" "example" {
}
resource "aws_dsql_clusterpolicy" "example" {
identifier = aws_dsql_cluster.example.identifier
policy = jsonencode({
"Version" = "2012-10-17"
"Statement" = [{
"Sid" = "DenyAccessFromOtherVPCs"
"Effect" = "Deny"
"Principal" = {
"AWS" = "*"
}
"Action" = ["dsql:DbConnect", "dsql:DbConnectAdmin"]
"Resource" = aws_dsql_cluster.example.arn
"Condition" = {
"StringNotEquals" = {
"aws:SourceVpc" = exampleAwsVpc.id
}
}
}]
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dsql.Cluster;
import com.pulumi.aws.dsql.ClusterPolicy;
import com.pulumi.aws.dsql.ClusterPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Cluster("example");
var exampleClusterPolicy = new ClusterPolicy("exampleClusterPolicy", ClusterPolicyArgs.builder()
.identifier(example.identifier())
.policy(example.arn().applyValue(_arn -> serializeJson(
jsonObject(
jsonProperty("Version", "2012-10-17"),
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Sid", "DenyAccessFromOtherVPCs"),
jsonProperty("Effect", "Deny"),
jsonProperty("Principal", jsonObject(
jsonProperty("AWS", "*")
)),
jsonProperty("Action", jsonArray(
"dsql:DbConnect",
"dsql:DbConnectAdmin"
)),
jsonProperty("Resource", _arn),
jsonProperty("Condition", jsonObject(
jsonProperty("StringNotEquals", jsonObject(
jsonProperty("aws:SourceVpc", exampleAwsVpc.id())
))
))
)))
))))
.build());
}
}
resources:
example:
type: aws:dsql:Cluster
exampleClusterPolicy:
type: aws:dsql:ClusterPolicy
name: example
properties:
identifier: ${example.identifier}
policy:
fn::toJSON:
Version: 2012-10-17
Statement:
- Sid: DenyAccessFromOtherVPCs
Effect: Deny
Principal:
AWS: '*'
Action:
- dsql:DbConnect
- dsql:DbConnectAdmin
Resource: ${example.arn}
Condition:
StringNotEquals:
aws:SourceVpc: ${exampleAwsVpc.id}
Restrict Access to an AWS Organization
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.dsql.Cluster("example", {});
const exampleClusterPolicy = new aws.dsql.ClusterPolicy("example", {
identifier: example.identifier,
policy: pulumi.jsonStringify({
Version: "2012-10-17",
Statement: [{
Sid: "DenyAccessFromOutsideOrganization",
Effect: "Deny",
Principal: {
AWS: "*",
},
Action: [
"dsql:DbConnect",
"dsql:DbConnectAdmin",
],
Resource: example.arn,
Condition: {
StringNotEquals: {
"aws:PrincipalOrgID": "o-exampleorgid",
},
},
}],
}),
});
import pulumi
import json
import pulumi_aws as aws
example = aws.dsql.Cluster("example")
example_cluster_policy = aws.dsql.ClusterPolicy("example",
identifier=example.identifier,
policy=pulumi.Output.json_dumps({
"Version": "2012-10-17",
"Statement": [{
"Sid": "DenyAccessFromOutsideOrganization",
"Effect": "Deny",
"Principal": {
"AWS": "*",
},
"Action": [
"dsql:DbConnect",
"dsql:DbConnectAdmin",
],
"Resource": example.arn,
"Condition": {
"StringNotEquals": {
"aws:PrincipalOrgID": "o-exampleorgid",
},
},
}],
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Dsql.Cluster("example");
var exampleClusterPolicy = new Aws.Dsql.ClusterPolicy("example", new()
{
Identifier = example.Identifier,
Policy = Output.JsonSerialize(Output.Create(new Dictionary<string, object?>
{
["Version"] = "2012-10-17",
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Sid"] = "DenyAccessFromOutsideOrganization",
["Effect"] = "Deny",
["Principal"] = new Dictionary<string, object?>
{
["AWS"] = "*",
},
["Action"] = new[]
{
"dsql:DbConnect",
"dsql:DbConnectAdmin",
},
["Resource"] = example.Arn,
["Condition"] = new Dictionary<string, object?>
{
["StringNotEquals"] = new Dictionary<string, object?>
{
["aws:PrincipalOrgID"] = "o-exampleorgid",
},
},
},
},
})),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/dsql"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := dsql.NewCluster(ctx, "example", nil)
if err != nil {
return err
}
_, err = dsql.NewClusterPolicy(ctx, "example", &dsql.ClusterPolicyArgs{
Identifier: example.Identifier,
Policy: example.Arn.ApplyT(func(arn string) (pulumi.String, error) {
var _zero pulumi.String
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Version": "2012-10-17",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Sid": "DenyAccessFromOutsideOrganization",
"Effect": "Deny",
"Principal": map[string]string{
"AWS": "*",
},
"Action": []string{
"dsql:DbConnect",
"dsql:DbConnectAdmin",
},
"Resource": arn,
"Condition": map[string]map[string]string{
"StringNotEquals": map[string]string{
"aws:PrincipalOrgID": "o-exampleorgid",
},
},
},
},
})
if err != nil {
return _zero, err
}
json0 := string(tmpJSON0)
return pulumi.String(json0), nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_dsql_cluster" "example" {
}
resource "aws_dsql_clusterpolicy" "example" {
identifier = aws_dsql_cluster.example.identifier
policy = jsonencode({
"Version" = "2012-10-17"
"Statement" = [{
"Sid" = "DenyAccessFromOutsideOrganization"
"Effect" = "Deny"
"Principal" = {
"AWS" = "*"
}
"Action" = ["dsql:DbConnect", "dsql:DbConnectAdmin"]
"Resource" = aws_dsql_cluster.example.arn
"Condition" = {
"StringNotEquals" = {
"aws:PrincipalOrgID" = "o-exampleorgid"
}
}
}]
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dsql.Cluster;
import com.pulumi.aws.dsql.ClusterPolicy;
import com.pulumi.aws.dsql.ClusterPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Cluster("example");
var exampleClusterPolicy = new ClusterPolicy("exampleClusterPolicy", ClusterPolicyArgs.builder()
.identifier(example.identifier())
.policy(example.arn().applyValue(_arn -> serializeJson(
jsonObject(
jsonProperty("Version", "2012-10-17"),
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Sid", "DenyAccessFromOutsideOrganization"),
jsonProperty("Effect", "Deny"),
jsonProperty("Principal", jsonObject(
jsonProperty("AWS", "*")
)),
jsonProperty("Action", jsonArray(
"dsql:DbConnect",
"dsql:DbConnectAdmin"
)),
jsonProperty("Resource", _arn),
jsonProperty("Condition", jsonObject(
jsonProperty("StringNotEquals", jsonObject(
jsonProperty("aws:PrincipalOrgID", "o-exampleorgid")
))
))
)))
))))
.build());
}
}
resources:
example:
type: aws:dsql:Cluster
exampleClusterPolicy:
type: aws:dsql:ClusterPolicy
name: example
properties:
identifier: ${example.identifier}
policy:
fn::toJSON:
Version: 2012-10-17
Statement:
- Sid: DenyAccessFromOutsideOrganization
Effect: Deny
Principal:
AWS: '*'
Action:
- dsql:DbConnect
- dsql:DbConnectAdmin
Resource: ${example.arn}
Condition:
StringNotEquals:
aws:PrincipalOrgID: o-exampleorgid
For more examples, including specific organizational units and multi-Region cluster policies, see the Aurora DSQL resource-based policy examples.
Import
Identity Schema
Required
identifier(String) Identifier of the Aurora DSQL Cluster.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import Aurora DSQL Cluster Policies using the cluster identifier. For example:
$ pulumi import aws:dsql/clusterPolicy:ClusterPolicy example abcde1f234ghijklmnop5qr6st
Constructors
- ClusterPolicy(String name, {ClusterPolicyArgs? args, CustomResourceOptions? options})
-
Creates a new ClusterPolicy.
nameThe Pulumi resource name.argsArguments used to configure this ClusterPolicy. The set of arguments for ClusterPolicy.optionsResource options controlling this resource's behavior. - ClusterPolicy.reference(String urn)
- Creates a typed reference to an existing ClusterPolicy resource.
Properties
-
bypassPolicyLockoutSafetyCheck
↔ Output<
bool> -
Whether to bypass the policy lockout safety check. Setting this value to
trueincreases the risk that the cluster becomes unmanageable. Defaults tofalse.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
identifier
↔ Output<
String> -
Identifier of the Aurora DSQL Cluster.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
policy
↔ Output<
String> -
Resource-based policy document as JSON.
latefinal
-
policyVersion
↔ Output<
String> -
Version of the policy document.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
timeouts
↔ Output<
ClusterPolicyTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ClusterPolicyState? state, CustomResourceOptions? options}) → ClusterPolicy -
Gets an existing ClusterPolicy resource's state with the given
nameandid.