Class: AWSCDK::SecretsManager::SecretRotationApplication

Inherits:
Jsii::Object
  • Object
show all
Defined in:
secrets_manager/secret_rotation_application.rb

Overview

A secret rotation serverless application.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_name, aws_semantic_version, options = nil) ⇒ SecretRotationApplication

Returns a new instance of SecretRotationApplication.

Parameters:

  • application_name (String) —
    • The name of the rotation application.
  • aws_semantic_version (String) —
    • AWS partition semantic version for the application.
  • options (AWSCDK::SecretsManager::SecretRotationApplicationOptions, nil) (defaults to: nil) —
    • Additional options for the rotation application.


11
12
13
14
15
16
17
 
# File 'secrets_manager/secret_rotation_application.rb', line 11

def initialize(application_name, aws_semantic_version, options = nil)
  options = options.is_a?(Hash) ? ::AWSCDK::SecretsManager::SecretRotationApplicationOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(application_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationName")
  Jsii::Type.check_type(aws_semantic_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsSemanticVersion")
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjcmV0c21hbmFnZXIuU2VjcmV0Um90YXRpb25BcHBsaWNhdGlvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(application_name, aws_semantic_version, options)
end

Class Method Details

.DB2_ROTATION_MULTI_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS Db2 using the multi user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


30
31
32
 
# File 'secrets_manager/secret_rotation_application.rb', line 30

def self.DB2_ROTATION_MULTI_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "DB2_ROTATION_MULTI_USER")
end

.DB2_ROTATION_SINGLE_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS Db2 using the single user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


37
38
39
 
# File 'secrets_manager/secret_rotation_application.rb', line 37

def self.DB2_ROTATION_SINGLE_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "DB2_ROTATION_SINGLE_USER")
end

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
 
# File 'secrets_manager/secret_rotation_application.rb', line 19

def self.jsii_overridable_methods
  {
    :is_multi_user => { kind: :property, name: "isMultiUser", is_optional: true },
    :application_arn_for_partition => { kind: :method, name: "applicationArnForPartition", is_optional: false },
    :semantic_version_for_partition => { kind: :method, name: "semanticVersionForPartition", is_optional: false },
  }
end

.MARIADB_ROTATION_MULTI_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the multi user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


44
45
46
 
# File 'secrets_manager/secret_rotation_application.rb', line 44

def self.MARIADB_ROTATION_MULTI_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "MARIADB_ROTATION_MULTI_USER")
end

.MARIADB_ROTATION_SINGLE_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the single user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


51
52
53
 
# File 'secrets_manager/secret_rotation_application.rb', line 51

def self.MARIADB_ROTATION_SINGLE_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "MARIADB_ROTATION_SINGLE_USER")
end

.MONGODB_ROTATION_MULTI_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for MongoDB using the multi user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


58
59
60
 
# File 'secrets_manager/secret_rotation_application.rb', line 58

def self.MONGODB_ROTATION_MULTI_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "MONGODB_ROTATION_MULTI_USER")
end

.MONGODB_ROTATION_SINGLE_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for MongoDB using the single user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


65
66
67
 
# File 'secrets_manager/secret_rotation_application.rb', line 65

def self.MONGODB_ROTATION_SINGLE_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "MONGODB_ROTATION_SINGLE_USER")
end

.MYSQL_ROTATION_MULTI_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS MySQL using the multi user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


72
73
74
 
# File 'secrets_manager/secret_rotation_application.rb', line 72

def self.MYSQL_ROTATION_MULTI_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "MYSQL_ROTATION_MULTI_USER")
end

.MYSQL_ROTATION_SINGLE_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS MySQL using the single user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


79
80
81
 
# File 'secrets_manager/secret_rotation_application.rb', line 79

def self.MYSQL_ROTATION_SINGLE_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "MYSQL_ROTATION_SINGLE_USER")
end

.ORACLE_ROTATION_MULTI_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS Oracle using the multi user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


86
87
88
 
# File 'secrets_manager/secret_rotation_application.rb', line 86

def self.ORACLE_ROTATION_MULTI_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "ORACLE_ROTATION_MULTI_USER")
end

.ORACLE_ROTATION_SINGLE_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS Oracle using the single user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


93
94
95
 
# File 'secrets_manager/secret_rotation_application.rb', line 93

def self.ORACLE_ROTATION_SINGLE_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "ORACLE_ROTATION_SINGLE_USER")
end

.POSTGRES_ROTATION_MULTI_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the multi user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


100
101
102
 
# File 'secrets_manager/secret_rotation_application.rb', line 100

def self.POSTGRES_ROTATION_MULTI_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "POSTGRES_ROTATION_MULTI_USER")
end

.POSTGRES_ROTATION_SINGLE_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the single user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


107
108
109
 
# File 'secrets_manager/secret_rotation_application.rb', line 107

def self.POSTGRES_ROTATION_SINGLE_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "POSTGRES_ROTATION_SINGLE_USER")
end

.REDSHIFT_ROTATION_MULTI_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the multi user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


114
115
116
 
# File 'secrets_manager/secret_rotation_application.rb', line 114

def self.REDSHIFT_ROTATION_MULTI_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "REDSHIFT_ROTATION_MULTI_USER")
end

.REDSHIFT_ROTATION_SINGLE_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the single user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


121
122
123
 
# File 'secrets_manager/secret_rotation_application.rb', line 121

def self.REDSHIFT_ROTATION_SINGLE_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "REDSHIFT_ROTATION_SINGLE_USER")
end

.SQLSERVER_ROTATION_MULTI_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS SQL Server using the multi user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


128
129
130
 
# File 'secrets_manager/secret_rotation_application.rb', line 128

def self.SQLSERVER_ROTATION_MULTI_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "SQLSERVER_ROTATION_MULTI_USER")
end

.SQLSERVER_ROTATION_SINGLE_USER ⇒ AWSCDK::SecretsManager::SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS SQL Server using the single user rotation scheme.

Returns:

  • (AWSCDK::SecretsManager::SecretRotationApplication) 


135
136
137
 
# File 'secrets_manager/secret_rotation_application.rb', line 135

def self.SQLSERVER_ROTATION_SINGLE_USER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_secretsmanager.SecretRotationApplication", "SQLSERVER_ROTATION_SINGLE_USER")
end

Instance Method Details

#application_arn_for_partition(partition) ⇒ String

Returns the application ARN for the current partition.

Can be used in combination with a CfnMapping to automatically select the correct ARN based on the current partition.

Parameters:

  • partition (String)

Returns:

  • (String) 


152
153
154
155
 
# File 'secrets_manager/secret_rotation_application.rb', line 152

def application_arn_for_partition(partition)
  Jsii::Type.check_type(partition, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "partition")
  jsii_call_method("applicationArnForPartition", [partition])
end

#is_multi_user ⇒ Boolean?

Whether the rotation application uses the multi user scheme.

Returns:

  • (Boolean, nil) 


142
143
144
 
# File 'secrets_manager/secret_rotation_application.rb', line 142

def is_multi_user()
  jsii_get_property("isMultiUser")
end

#semantic_version_for_partition(partition) ⇒ String

The semantic version of the app for the current partition.

Can be used in combination with a CfnMapping to automatically select the correct version based on the current partition.

Parameters:

  • partition (String)

Returns:

  • (String) 


163
164
165
166
 
# File 'secrets_manager/secret_rotation_application.rb', line 163

def semantic_version_for_partition(partition)
  Jsii::Type.check_type(partition, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "partition")
  jsii_call_method("semanticVersionForPartition", [partition])
end