Class SnapshotSchedule
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var @default = new Aws.RedShift.SnapshotSchedule("default", new Aws.RedShift.SnapshotScheduleArgs
{
Definitions =
{
"rate(12 hours)",
},
Identifier = "tf-redshift-snapshot-schedule",
});
}
}
Inherited Members
Namespace: Pulumi.Aws.RedShift
Assembly: Pulumi.Aws.dll
Syntax
public class SnapshotSchedule : CustomResource
Constructors
View SourceSnapshotSchedule(String, SnapshotScheduleArgs, CustomResourceOptions)
Create a SnapshotSchedule resource with the given unique name, arguments, and options.
Declaration
public SnapshotSchedule(string name, SnapshotScheduleArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| SnapshotScheduleArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceArn
Declaration
public Output<string> Arn { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Definitions
The definition of the snapshot schedule. The definition is made up of schedule expressions, for example cron(30 12 *) or rate(12 hours).
Declaration
public Output<ImmutableArray<string>> Definitions { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<System.String>> |
Description
The description of the snapshot schedule.
Declaration
public Output<string> Description { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ForceDestroy
Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
Declaration
public Output<bool?> ForceDestroy { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
Identifier
The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
Declaration
public Output<string> Identifier { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
IdentifierPrefix
Creates a unique
identifier beginning with the specified prefix. Conflicts with identifier.
Declaration
public Output<string> IdentifierPrefix { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Tags
A map of tags to assign to the resource.
Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>> |
Methods
View SourceGet(String, Input<String>, SnapshotScheduleState, CustomResourceOptions)
Get an existing SnapshotSchedule resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static SnapshotSchedule Get(string name, Input<string> id, SnapshotScheduleState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| SnapshotScheduleState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| SnapshotSchedule |