Redis

Defang AWS v2.4.1, Jul 11 26

Viewing docs for Defang AWS v2.4.1
published on Saturday, Jul 11, 2026 by Defang

Schema (JSON)

DefangLabs/pulumi-defang

Viewing docs for Defang AWS v2.4.1
published on Saturday, Jul 11, 2026 by Defang

Schema (JSON)

DefangLabs/pulumi-defang

Create Redis Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Redis(name: string, args: RedisArgs, opts?: ComponentResourceOptions);

@overload
def Redis(resource_name: str,
          args: RedisArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Redis(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          project_name: Optional[str] = None,
          aws: Optional[_aws.SharedInfraArgs] = None,
          deploy: Optional[_compose.DeployConfigArgs] = None,
          environment: Optional[Mapping[str, str]] = None,
          image: Optional[str] = None,
          ports: Optional[Sequence[_compose.ServicePortConfigArgs]] = None,
          redis: Optional[_compose.RedisConfigArgs] = None)

func NewRedis(ctx *Context, name string, args RedisArgs, opts ...ResourceOption) (*Redis, error)

public Redis(string name, RedisArgs args, ComponentResourceOptions? opts = null)

public Redis(String name, RedisArgs args)
public Redis(String name, RedisArgs args, ComponentResourceOptions options)

type: defang-aws:Redis
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "defang-aws_redis" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args RedisArgs: The arguments to resource properties.
opts ComponentResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RedisArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RedisArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RedisArgs: The arguments to resource properties.
opts ComponentResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RedisArgs: The arguments to resource properties.
options ComponentResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var redisResource = new DefangAws.Redis("redisResource", new()
{
    ProjectName = "string",
    Aws = new DefangAws.Aws.Inputs.SharedInfraArgs
    {
        VpcID = "string",
        ClusterArn = "string",
        ExecutionRoleArn = "string",
        LogGroupName = "string",
        PrivateSgID = "string",
        PrivateSubnetIDs = new[]
        {
            "string",
        },
        PrivateZoneID = "string",
        PublicSubnetIDs = new[]
        {
            "string",
        },
    },
    Deploy = new DefangAws.Compose.Inputs.DeployConfigArgs
    {
        Replicas = 0,
        Resources = new DefangAws.Compose.Inputs.ResourcesArgs
        {
            Reservations = new DefangAws.Compose.Inputs.ResourceConfigArgs
            {
                Cpus = 0,
                Memory = "string",
            },
        },
    },
    Environment = 
    {
        { "string", "string" },
    },
    Image = "string",
    Ports = new[]
    {
        new DefangAws.Compose.Inputs.ServicePortConfigArgs
        {
            Target = 0,
            AppProtocol = "string",
            Listener = "string",
            Mode = "string",
            Protocol = "string",
        },
    },
    Redis = new DefangAws.Compose.Inputs.RedisConfigArgs
    {
        AllowDowntime = false,
        FromSnapshot = "string",
    },
});

example, err := defangaws.NewRedis(ctx, "redisResource", &defangaws.RedisArgs{
	ProjectName: "string",
	Aws: &aws.SharedInfraArgs{
		VpcID:            pulumi.String("string"),
		ClusterArn:       pulumi.String("string"),
		ExecutionRoleArn: pulumi.String("string"),
		LogGroupName:     pulumi.String("string"),
		PrivateSgID:      pulumi.String("string"),
		PrivateSubnetIDs: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrivateZoneID: pulumi.String("string"),
		PublicSubnetIDs: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Deploy: &compose.DeployConfigArgs{
		Replicas: pulumi.Int(0),
		Resources: &compose.ResourcesArgs{
			Reservations: &compose.ResourceConfigArgs{
				Cpus:   pulumi.Float64(0),
				Memory: pulumi.String("string"),
			},
		},
	},
	Environment: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Image: "string",
	Ports: compose.ServicePortConfigArray{
		&compose.ServicePortConfigArgs{
			Target:      pulumi.Int(0),
			AppProtocol: pulumi.String("string"),
			Listener:    pulumi.String("string"),
			Mode:        pulumi.String("string"),
			Protocol:    pulumi.String("string"),
		},
	},
	Redis: &compose.RedisConfigArgs{
		AllowDowntime: pulumi.Bool(false),
		FromSnapshot:  pulumi.String("string"),
	},
})

resource "defang-aws_redis" "redisResource" {
  project_name = "string"
  aws = {
    vpc_id              = "string"
    cluster_arn         = "string"
    execution_role_arn  = "string"
    log_group_name      = "string"
    private_sg_id       = "string"
    private_subnet_i_ds = ["string"]
    private_zone_id     = "string"
    public_subnet_i_ds  = ["string"]
  }
  deploy = {
    replicas = 0
    resources = {
      reservations = {
        cpus   = 0
        memory = "string"
      }
    }
  }
  environment = {
    "string" = "string"
  }
  image = "string"
  ports {
    target       = 0
    app_protocol = "string"
    listener     = "string"
    mode         = "string"
    protocol     = "string"
  }
  redis = {
    allow_downtime = false
    from_snapshot  = "string"
  }
}

var redisResource = new Redis("redisResource", RedisArgs.builder()
    .projectName("string")
    .aws(SharedInfraArgs.builder()
        .vpcID("string")
        .clusterArn("string")
        .executionRoleArn("string")
        .logGroupName("string")
        .privateSgID("string")
        .privateSubnetIDs("string")
        .privateZoneID("string")
        .publicSubnetIDs("string")
        .build())
    .deploy(DeployConfigArgs.builder()
        .replicas(0)
        .resources(ResourcesArgs.builder()
            .reservations(ResourceConfigArgs.builder()
                .cpus(0.0)
                .memory("string")
                .build())
            .build())
        .build())
    .environment(Map.of("string", "string"))
    .image("string")
    .ports(ServicePortConfigArgs.builder()
        .target(0)
        .appProtocol("string")
        .listener("string")
        .mode("string")
        .protocol("string")
        .build())
    .redis(RedisConfigArgs.builder()
        .allowDowntime(false)
        .fromSnapshot("string")
        .build())
    .build());

redis_resource = defang_aws.Redis("redisResource",
    project_name="string",
    aws={
        "vpc_id": "string",
        "cluster_arn": "string",
        "execution_role_arn": "string",
        "log_group_name": "string",
        "private_sg_id": "string",
        "private_subnet_ids": ["string"],
        "private_zone_id": "string",
        "public_subnet_ids": ["string"],
    },
    deploy={
        "replicas": 0,
        "resources": {
            "reservations": {
                "cpus": float(0),
                "memory": "string",
            },
        },
    },
    environment={
        "string": "string",
    },
    image="string",
    ports=[{
        "target": 0,
        "app_protocol": "string",
        "listener": "string",
        "mode": "string",
        "protocol": "string",
    }],
    redis={
        "allow_downtime": False,
        "from_snapshot": "string",
    })

const redisResource = new defang_aws.Redis("redisResource", {
    projectName: "string",
    aws: {
        vpcID: "string",
        clusterArn: "string",
        executionRoleArn: "string",
        logGroupName: "string",
        privateSgID: "string",
        privateSubnetIDs: ["string"],
        privateZoneID: "string",
        publicSubnetIDs: ["string"],
    },
    deploy: {
        replicas: 0,
        resources: {
            reservations: {
                cpus: 0,
                memory: "string",
            },
        },
    },
    environment: {
        string: "string",
    },
    image: "string",
    ports: [{
        target: 0,
        appProtocol: "string",
        listener: "string",
        mode: "string",
        protocol: "string",
    }],
    redis: {
        allowDowntime: false,
        fromSnapshot: "string",
    },
});

type: defang-aws:Redis
properties:
    aws:
        clusterArn: string
        executionRoleArn: string
        logGroupName: string
        privateSgID: string
        privateSubnetIDs:
            - string
        privateZoneID: string
        publicSubnetIDs:
            - string
        vpcID: string
    deploy:
        replicas: 0
        resources:
            reservations:
                cpus: 0
                memory: string
    environment:
        string: string
    image: string
    ports:
        - appProtocol: string
          listener: string
          mode: string
          protocol: string
          target: 0
    projectName: string
    redis:
        allowDowntime: false
        fromSnapshot: string