Class: AWSCDK::RedshiftServerless::CfnSnapshot::SnapshotProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
redshift_serverless/cfn_snapshot.rb

Overview

A snapshot object that contains databases.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(admin_username: nil, kms_key_id: nil, namespace_arn: nil, namespace_name: nil, owner_account: nil, retention_period: nil, snapshot_arn: nil, snapshot_create_time: nil, snapshot_name: nil, status: nil) ⇒ SnapshotProperty

Returns a new instance of SnapshotProperty.

Parameters:

  • admin_username (String, nil) (defaults to: nil) —

    The username of the database within a snapshot.

  • kms_key_id (String, nil) (defaults to: nil) —

    The unique identifier of the KMS key used to encrypt the snapshot.

  • namespace_arn (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

  • namespace_name (String, nil) (defaults to: nil) —

    The name of the namepsace.

  • owner_account (String, nil) (defaults to: nil) —

    The owner AWS ;

  • retention_period (Numeric, nil) (defaults to: nil) —

    The retention period of the snapshot created by the scheduled action.

  • snapshot_arn (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the snapshot.

  • snapshot_create_time (String, nil) (defaults to: nil) —

    The timestamp of when the snapshot was created.

  • snapshot_name (String, nil) (defaults to: nil) —

    The name of the snapshot.

  • status (String, nil) (defaults to: nil) —

    The status of the snapshot.



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'redshift_serverless/cfn_snapshot.rb', line 648

def initialize(admin_username: nil, kms_key_id: nil, namespace_arn: nil, namespace_name: nil, owner_account: nil, retention_period: nil, snapshot_arn: nil, snapshot_create_time: nil, snapshot_name: nil, status: nil)
  @admin_username = admin_username
  Jsii::Type.check_type(@admin_username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "adminUsername") unless @admin_username.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @namespace_arn = namespace_arn
  Jsii::Type.check_type(@namespace_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "namespaceArn") unless @namespace_arn.nil?
  @namespace_name = namespace_name
  Jsii::Type.check_type(@namespace_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "namespaceName") unless @namespace_name.nil?
  @owner_account = 
  Jsii::Type.check_type(@owner_account, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ownerAccount") unless @owner_account.nil?
  @retention_period = retention_period
  Jsii::Type.check_type(@retention_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retentionPeriod") unless @retention_period.nil?
  @snapshot_arn = snapshot_arn
  Jsii::Type.check_type(@snapshot_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotArn") unless @snapshot_arn.nil?
  @snapshot_create_time = snapshot_create_time
  Jsii::Type.check_type(@snapshot_create_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotCreateTime") unless @snapshot_create_time.nil?
  @snapshot_name = snapshot_name
  Jsii::Type.check_type(@snapshot_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotName") unless @snapshot_name.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
end

Instance Attribute Details

#admin_username ⇒ String? (readonly)

The username of the database within a snapshot.

Returns:

  • (String, nil)

See Also:



675
676
677
 
# File 'redshift_serverless/cfn_snapshot.rb', line 675

def admin_username
  @admin_username
end

#kms_key_id ⇒ String? (readonly)

The unique identifier of the KMS key used to encrypt the snapshot.

Returns:

  • (String, nil)

See Also:



680
681
682
 
# File 'redshift_serverless/cfn_snapshot.rb', line 680

def kms_key_id
  @kms_key_id
end

#namespace_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

Returns:

  • (String, nil)

See Also:



685
686
687
 
# File 'redshift_serverless/cfn_snapshot.rb', line 685

def namespace_arn
  @namespace_arn
end

#namespace_name ⇒ String? (readonly)

The name of the namepsace.

Returns:

  • (String, nil)

See Also:



690
691
692
 
# File 'redshift_serverless/cfn_snapshot.rb', line 690

def namespace_name
  @namespace_name
end

#owner_account ⇒ String? (readonly)

The owner AWS ;

account of the snapshot.

Returns:

  • (String, nil)

See Also:



697
698
699
 
# File 'redshift_serverless/cfn_snapshot.rb', line 697

def 
  @owner_account
end

#retention_period ⇒ Numeric? (readonly)

The retention period of the snapshot created by the scheduled action.

Returns:

  • (Numeric, nil)

See Also:



702
703
704
 
# File 'redshift_serverless/cfn_snapshot.rb', line 702

def retention_period
  @retention_period
end

#snapshot_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the snapshot.

Returns:

  • (String, nil)

See Also:



707
708
709
 
# File 'redshift_serverless/cfn_snapshot.rb', line 707

def snapshot_arn
  @snapshot_arn
end

#snapshot_create_time ⇒ String? (readonly)

The timestamp of when the snapshot was created.

Returns:

  • (String, nil)

See Also:



712
713
714
 
# File 'redshift_serverless/cfn_snapshot.rb', line 712

def snapshot_create_time
  @snapshot_create_time
end

#snapshot_name ⇒ String? (readonly)

The name of the snapshot.

Returns:

  • (String, nil)

See Also:



717
718
719
 
# File 'redshift_serverless/cfn_snapshot.rb', line 717

def snapshot_name
  @snapshot_name
end

#status ⇒ String? (readonly)

The status of the snapshot.

Returns:

  • (String, nil)

See Also:



722
723
724
 
# File 'redshift_serverless/cfn_snapshot.rb', line 722

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'redshift_serverless/cfn_snapshot.rb', line 724

def self.jsii_properties
  {
    :admin_username => "adminUsername",
    :kms_key_id => "kmsKeyId",
    :namespace_arn => "namespaceArn",
    :namespace_name => "namespaceName",
    :owner_account => "ownerAccount",
    :retention_period => "retentionPeriod",
    :snapshot_arn => "snapshotArn",
    :snapshot_create_time => "snapshotCreateTime",
    :snapshot_name => "snapshotName",
    :status => "status",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'redshift_serverless/cfn_snapshot.rb', line 739

def to_jsii
  result = {}
  result.merge!({
    "adminUsername" => @admin_username,
    "kmsKeyId" => @kms_key_id,
    "namespaceArn" => @namespace_arn,
    "namespaceName" => @namespace_name,
    "ownerAccount" => @owner_account,
    "retentionPeriod" => @retention_period,
    "snapshotArn" => @snapshot_arn,
    "snapshotCreateTime" => @snapshot_create_time,
    "snapshotName" => @snapshot_name,
    "status" => @status,
  })
  result.compact
end