Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. redshift
  5. SnapshotSchedule

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.redshift.SnapshotSchedule

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const _default = new aws.redshift.SnapshotSchedule("default", {
    identifier: "tf-redshift-snapshot-schedule",
    definitions: ["rate(12 hours)"],
});

    import pulumi
import pulumi_aws as aws

default = aws.redshift.SnapshotSchedule("default",
    identifier="tf-redshift-snapshot-schedule",
    definitions=["rate(12 hours)"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshift.NewSnapshotSchedule(ctx, "default", &redshift.SnapshotScheduleArgs{
			Identifier: pulumi.String("tf-redshift-snapshot-schedule"),
			Definitions: pulumi.StringArray{
				pulumi.String("rate(12 hours)"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.RedShift.SnapshotSchedule("default", new()
    {
        Identifier = "tf-redshift-snapshot-schedule",
        Definitions = new[]
        {
            "rate(12 hours)",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.SnapshotSchedule;
import com.pulumi.aws.redshift.SnapshotScheduleArgs;
import java.util.List;
import java.util.ArrayList;
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 default_ = new SnapshotSchedule("default", SnapshotScheduleArgs.builder()
            .identifier("tf-redshift-snapshot-schedule")
            .definitions("rate(12 hours)")
            .build());

    }
}

    resources:
  default:
    type: aws:redshift:SnapshotSchedule
    properties:
      identifier: tf-redshift-snapshot-schedule
      definitions:
        - rate(12 hours)

    Create SnapshotSchedule Resource

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

    Constructor syntax

    new SnapshotSchedule(name: string, args: SnapshotScheduleArgs, opts?: CustomResourceOptions);
    @overload
def SnapshotSchedule(resource_name: str,
                     args: SnapshotScheduleArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def SnapshotSchedule(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     definitions: Optional[Sequence[str]] = None,
                     description: Optional[str] = None,
                     force_destroy: Optional[bool] = None,
                     identifier: Optional[str] = None,
                     identifier_prefix: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewSnapshotSchedule(ctx *Context, name string, args SnapshotScheduleArgs, opts ...ResourceOption) (*SnapshotSchedule, error)
    public SnapshotSchedule(string name, SnapshotScheduleArgs args, CustomResourceOptions? opts = null)
    public SnapshotSchedule(String name, SnapshotScheduleArgs args)
public SnapshotSchedule(String name, SnapshotScheduleArgs args, CustomResourceOptions options)

    type: aws:redshift:SnapshotSchedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SnapshotScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SnapshotScheduleArgs
    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 SnapshotScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnapshotScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnapshotScheduleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var snapshotScheduleResource = new Aws.RedShift.SnapshotSchedule("snapshotScheduleResource", new()
{
    Definitions = new[]
    {
        "string",
    },
    Description = "string",
    ForceDestroy = false,
    Identifier = "string",
    IdentifierPrefix = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := redshift.NewSnapshotSchedule(ctx, "snapshotScheduleResource", &redshift.SnapshotScheduleArgs{
	Definitions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:      pulumi.String("string"),
	ForceDestroy:     pulumi.Bool(false),
	Identifier:       pulumi.String("string"),
	IdentifierPrefix: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var snapshotScheduleResource = new SnapshotSchedule("snapshotScheduleResource", SnapshotScheduleArgs.builder()
    .definitions("string")
    .description("string")
    .forceDestroy(false)
    .identifier("string")
    .identifierPrefix("string")
    .tags(Map.of("string", "string"))
    .build());

    snapshot_schedule_resource = aws.redshift.SnapshotSchedule("snapshotScheduleResource",
    definitions=["string"],
    description="string",
    force_destroy=False,
    identifier="string",
    identifier_prefix="string",
    tags={
        "string": "string",
    })

    const snapshotScheduleResource = new aws.redshift.SnapshotSchedule("snapshotScheduleResource", {
    definitions: ["string"],
    description: "string",
    forceDestroy: false,
    identifier: "string",
    identifierPrefix: "string",
    tags: {
        string: "string",
    },
});

    type: aws:redshift:SnapshotSchedule
properties:
    definitions:
        - string
    description: string
    forceDestroy: false
    identifier: string
    identifierPrefix: string
    tags:
        string: string

    SnapshotSchedule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SnapshotSchedule resource accepts the following input properties:

    Definitions List<string>
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    Description string
    The description of the snapshot schedule.
    ForceDestroy bool
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    Identifier string
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    IdentifierPrefix string
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Definitions []string
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    Description string
    The description of the snapshot schedule.
    ForceDestroy bool
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    Identifier string
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    IdentifierPrefix string
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    definitions List<String>
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    description String
    The description of the snapshot schedule.
    forceDestroy Boolean
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    identifier String
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    identifierPrefix String
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    definitions string[]
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    description string
    The description of the snapshot schedule.
    forceDestroy boolean
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    identifier string
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    identifierPrefix string
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    definitions Sequence[str]
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    description str
    The description of the snapshot schedule.
    force_destroy bool
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    identifier str
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    identifier_prefix str
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    definitions List<String>
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    description String
    The description of the snapshot schedule.
    forceDestroy Boolean
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    identifier String
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    identifierPrefix String
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SnapshotSchedule resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing SnapshotSchedule Resource

    Get an existing SnapshotSchedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SnapshotScheduleState, opts?: CustomResourceOptions): SnapshotSchedule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        definitions: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        force_destroy: Optional[bool] = None,
        identifier: Optional[str] = None,
        identifier_prefix: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> SnapshotSchedule
    func GetSnapshotSchedule(ctx *Context, name string, id IDInput, state *SnapshotScheduleState, opts ...ResourceOption) (*SnapshotSchedule, error)
    public static SnapshotSchedule Get(string name, Input<string> id, SnapshotScheduleState? state, CustomResourceOptions? opts = null)
    public static SnapshotSchedule get(String name, Output<String> id, SnapshotScheduleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    Definitions List<string>
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    Description string
    The description of the snapshot schedule.
    ForceDestroy bool
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    Identifier string
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    IdentifierPrefix string
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    Definitions []string
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    Description string
    The description of the snapshot schedule.
    ForceDestroy bool
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    Identifier string
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    IdentifierPrefix string
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    definitions List<String>
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    description String
    The description of the snapshot schedule.
    forceDestroy Boolean
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    identifier String
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    identifierPrefix String
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    definitions string[]
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    description string
    The description of the snapshot schedule.
    forceDestroy boolean
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    identifier string
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    identifierPrefix string
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    definitions Sequence[str]
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    description str
    The description of the snapshot schedule.
    force_destroy bool
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    identifier str
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    identifier_prefix str
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the Redshift Snapshot Schedule.
    definitions List<String>
    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
    description String
    The description of the snapshot schedule.
    forceDestroy Boolean
    Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
    identifier String
    The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
    identifierPrefix String
    Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import Redshift Snapshot Schedule using the identifier. For example:

    $ pulumi import aws:redshift/snapshotSchedule:SnapshotSchedule default tf-redshift-snapshot-schedule

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws