The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::RDS::DescribeDBInstanceAutomatedBackups - Arguments for method DescribeDBInstanceAutomatedBackups on Paws::RDS

DESCRIPTION

This class represents the parameters used for calling the method DescribeDBInstanceAutomatedBackups on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method DescribeDBInstanceAutomatedBackups.

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

SYNOPSIS

    my $rds = Paws->service('RDS');
    my $DBInstanceAutomatedBackupMessage =
      $rds->DescribeDBInstanceAutomatedBackups(
      DBInstanceAutomatedBackupsArn => 'MyString',    # OPTIONAL
      DBInstanceIdentifier          => 'MyString',    # OPTIONAL
      DbiResourceId                 => 'MyString',    # OPTIONAL
      Filters                       => [
        {
          Name   => 'MyString',
          Values => [ 'MyString', ... ],

        },
        ...
      ],                                              # OPTIONAL
      Marker     => 'MyString',                       # OPTIONAL
      MaxRecords => 1,                                # OPTIONAL
      );

    # Results:
    my $DBInstanceAutomatedBackups =
      $DBInstanceAutomatedBackupMessage->DBInstanceAutomatedBackups;
    my $Marker = $DBInstanceAutomatedBackupMessage->Marker;

    # Returns a L<Paws::RDS::DBInstanceAutomatedBackupMessage> 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/rds/DescribeDBInstanceAutomatedBackups

ATTRIBUTES

DBInstanceAutomatedBackupsArn => Str

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

DBInstanceIdentifier => Str

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.

DbiResourceId => Str

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

Filters => ArrayRef[Paws::RDS::Filter]

A filter that specifies which resources to return based on status.

Supported filters are the following:

  • status

    • active - automated backups for current instances

    • retained - automated backups for deleted instances and after backup replication is stopped

    • creating - automated backups that are waiting for the first automated snapshot to be available

  • db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

  • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

Marker => Str

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

MaxRecords => Int

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeDBInstanceAutomatedBackups in Paws::RDS

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