com.pulumi.aws.memorydb.Snapshot Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.memorydb;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.memorydb.SnapshotArgs;
import com.pulumi.aws.memorydb.inputs.SnapshotState;
import com.pulumi.aws.memorydb.outputs.SnapshotClusterConfiguration;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a MemoryDB Snapshot.
*
* More information about snapshot and restore can be found in the [MemoryDB User Guide](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots.html).
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.memorydb.Snapshot;
* import com.pulumi.aws.memorydb.SnapshotArgs;
* 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 example = new Snapshot("example", SnapshotArgs.builder()
* .clusterName(exampleAwsMemorydbCluster.name())
* .name("my-snapshot")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import a snapshot using the `name`. For example:
*
* ```sh
* $ pulumi import aws:memorydb/snapshot:Snapshot example my-snapshot
* ```
*
*/
@ResourceType(type="aws:memorydb/snapshot:Snapshot")
public class Snapshot extends com.pulumi.resources.CustomResource {
/**
* The ARN of the snapshot.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return The ARN of the snapshot.
*
*/
public Output arn() {
return this.arn;
}
/**
* The configuration of the cluster from which the snapshot was taken.
*
*/
@Export(name="clusterConfigurations", refs={List.class,SnapshotClusterConfiguration.class}, tree="[0,1]")
private Output> clusterConfigurations;
/**
* @return The configuration of the cluster from which the snapshot was taken.
*
*/
public Output> clusterConfigurations() {
return this.clusterConfigurations;
}
/**
* Name of the MemoryDB cluster to take a snapshot of.
*
*/
@Export(name="clusterName", refs={String.class}, tree="[0]")
private Output clusterName;
/**
* @return Name of the MemoryDB cluster to take a snapshot of.
*
*/
public Output clusterName() {
return this.clusterName;
}
/**
* ARN of the KMS key used to encrypt the snapshot at rest.
*
*/
@Export(name="kmsKeyArn", refs={String.class}, tree="[0]")
private Output kmsKeyArn;
/**
* @return ARN of the KMS key used to encrypt the snapshot at rest.
*
*/
public Output> kmsKeyArn() {
return Codegen.optional(this.kmsKeyArn);
}
/**
* Name of the snapshot. If omitted, the provider will assign a random, unique name. Conflicts with `name_prefix`.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Name of the snapshot. If omitted, the provider will assign a random, unique name. Conflicts with `name_prefix`.
*
*/
public Output name() {
return this.name;
}
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*
*/
@Export(name="namePrefix", refs={String.class}, tree="[0]")
private Output namePrefix;
/**
* @return Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*
*/
public Output namePrefix() {
return this.namePrefix;
}
/**
* Indicates whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`).
*
*/
@Export(name="source", refs={String.class}, tree="[0]")
private Output source;
/**
* @return Indicates whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`).
*
*/
public Output source() {
return this.source;
}
/**
* 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.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return 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.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tagsAll;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Snapshot(java.lang.String name) {
this(name, SnapshotArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Snapshot(java.lang.String name, SnapshotArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Snapshot(java.lang.String name, SnapshotArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:memorydb/snapshot:Snapshot", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Snapshot(java.lang.String name, Output id, @Nullable SnapshotState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:memorydb/snapshot:Snapshot", name, state, makeResourceOptions(options, id), false);
}
private static SnapshotArgs makeArgs(SnapshotArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? SnapshotArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static Snapshot get(java.lang.String name, Output id, @Nullable SnapshotState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Snapshot(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy