/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RedShift::RestoreFromClusterSnapshot

NAME

Paws::RedShift::RestoreFromClusterSnapshot - Arguments for method RestoreFromClusterSnapshot on Paws::RedShift

DESCRIPTION

This class represents the parameters used for calling the method RestoreFromClusterSnapshot on the Amazon Redshift service. Use the attributes of this class as arguments to method RestoreFromClusterSnapshot.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreFromClusterSnapshot.

SYNOPSIS

my $redshift = Paws->service('RedShift');
my $RestoreFromClusterSnapshotResult =
  $redshift->RestoreFromClusterSnapshot(
  ClusterIdentifier                => 'MyString',
  SnapshotIdentifier               => 'MyString',
  AdditionalInfo                   => 'MyString',    # OPTIONAL
  AllowVersionUpgrade              => 1,             # OPTIONAL
  AquaConfigurationStatus          => 'enabled',     # OPTIONAL
  AutomatedSnapshotRetentionPeriod => 1,             # OPTIONAL
  AvailabilityZone                 => 'MyString',    # OPTIONAL
  AvailabilityZoneRelocation       => 1,             # OPTIONAL
  ClusterParameterGroupName        => 'MyString',    # OPTIONAL
  ClusterSecurityGroups            => [
    'MyString', ...                                  # max: 2147483647
  ],    # OPTIONAL
  ClusterSubnetGroupName         => 'MyString',    # OPTIONAL
  ElasticIp                      => 'MyString',    # OPTIONAL
  EnhancedVpcRouting             => 1,             # OPTIONAL
  HsmClientCertificateIdentifier => 'MyString',    # OPTIONAL
  HsmConfigurationIdentifier     => 'MyString',    # OPTIONAL
  IamRoles                       => [
    'MyString', ...                                # max: 2147483647
  ],    # OPTIONAL
  KmsKeyId                      => 'MyString',    # OPTIONAL
  MaintenanceTrackName          => 'MyString',    # OPTIONAL
  ManualSnapshotRetentionPeriod => 1,             # OPTIONAL
  NodeType                      => 'MyString',    # OPTIONAL
  NumberOfNodes                 => 1,             # OPTIONAL
  OwnerAccount                  => 'MyString',    # OPTIONAL
  Port                          => 1,             # OPTIONAL
  PreferredMaintenanceWindow    => 'MyString',    # OPTIONAL
  PubliclyAccessible            => 1,             # OPTIONAL
  SnapshotClusterIdentifier     => 'MyString',    # OPTIONAL
  SnapshotScheduleIdentifier    => 'MyString',    # OPTIONAL
  VpcSecurityGroupIds           => [
    'MyString', ...                               # max: 2147483647
  ],    # OPTIONAL
  );

# Results:
my $Cluster = $RestoreFromClusterSnapshotResult->Cluster;

# Returns a L<Paws::RedShift::RestoreFromClusterSnapshotResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/redshift/RestoreFromClusterSnapshot

ATTRIBUTES

AdditionalInfo => Str

Reserved.

AllowVersionUpgrade => Bool

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

Default: true

AquaConfigurationStatus => Str

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Valid values are: "enabled", "disabled", "auto"

AutomatedSnapshotRetentionPeriod => Int

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: The value selected for the cluster from which the snapshot was taken.

Constraints: Must be a value from 0 to 35.

AvailabilityZone => Str

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

AvailabilityZoneRelocation => Bool

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

REQUIRED ClusterIdentifier => Str

The identifier of the cluster that will be created from restoring the snapshot.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters within an AWS account.

ClusterParameterGroupName => Str

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html).

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

ClusterSecurityGroups => ArrayRef[Str|Undef]

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Cluster security groups only apply to clusters outside of VPCs.

ClusterSubnetGroupName => Str

The name of the subnet group where you want to cluster restored.

A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

ElasticIp => Str

The elastic IP (EIP) address for the cluster.

EnhancedVpcRouting => Bool

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

HsmClientCertificateIdentifier => Str

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

HsmConfigurationIdentifier => Str

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

IamRoles => ArrayRef[Str|Undef]

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

A cluster can have up to 10 IAM roles associated at any time.

KmsKeyId => Str

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.

MaintenanceTrackName => Str

The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.

ManualSnapshotRetentionPeriod => Int

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

NodeType => Str

The node type that the restored cluster will be provisioned with.

Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes) in the Amazon Redshift Cluster Management Guide.

NumberOfNodes => Int

The number of nodes specified when provisioning the restored cluster.

OwnerAccount => Str

The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

Port => Int

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

PreferredMaintenanceWindow => Str

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

PubliclyAccessible => Bool

If true, the cluster can be accessed from a public network.

SnapshotClusterIdentifier => Str

The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

REQUIRED SnapshotIdentifier => Str

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

SnapshotScheduleIdentifier => Str

A unique identifier for the snapshot schedule.

VpcSecurityGroupIds => ArrayRef[Str|Undef]

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

VPC security groups only apply to clusters in VPCs.

SEE ALSO

This class forms part of Paws, documenting arguments for method RestoreFromClusterSnapshot in Paws::RedShift

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues