Class: Convection::Model::Template::Resource::RDSDBCluster

Inherits:
Convection::Model::Template::Resource show all
Includes:
Mixin::Taggable
Defined in:
lib/convection/model/template/resource/aws_rds_db_cluster.rb

Overview

AWS::RDS::DBCluster

Examples:

rds_cluster 'TestCluster' do
     availability_zone 'us-east-1','us-east-2'
     backup_retention 10
     database_name 'test_database'
     identifier 'cluster1'
     cluster_parameter_group_name 'default.aurora5.6'
     subnet_group 'subnet_group'
     engine 'aurora'
     engine_version '5.6.10a'
     kms_key_id 'kms_key'
     master_username 'username'
     master_password 'password'
     port '3306'
     preferred_backup_window '12:30-01:30'
     preferred_maintenance_window 'mon:2:30-mon:3:30'
     replication_source_identifier 'source_instance'
     snapshot_identifier
     storage_encrypted 'false'
     tag 'Name', 'Test'
     vpc_security_group 'test_security_group_1' ,'test_security_group_2'
 end

See Also:

Instance Attribute Summary

Attributes inherited from Convection::Model::Template::Resource

#exist, #name, #parent, #properties, #resource_attributes, #template

Instance Method Summary collapse

Methods included from Mixin::Taggable

#immutable_metadata, #render_tags, #tag, #tags

Methods inherited from Convection::Model::Template::Resource

#as_attribute, attach_method, #deletion_policy, #depends_on, #initialize, properties, property, #property, #reference, type, #type, #with_output

Methods included from Mixin::Conditional

#condition, #render_condition

Methods included from DSL::Template::Resource

#_terraform_module_dir_to_flag, #_terraform_module_flag_to_dir, attach_resource, attach_resource_collection, resource_collection_dsl_methods, resource_dsl_methods

Methods included from DSL::Helpers

#camel_case, included, method_name, #screaming_snake_case, #snake_case

Methods included from DSL::IntrinsicFunctions

#base64, #find_in_map, #fn_and, #fn_equals, #fn_if, #fn_import_value, #fn_not, #fn_or, #fn_ref, #fn_sub, #get_att, #get_azs, included, #join, mixers, #select

Constructor Details

This class inherits a constructor from Convection::Model::Template::Resource

Instance Method Details

#availability_zone ⇒ Object #availability_zone(value) ⇒ Object

Overloads:

  • #availability_zone ⇒ Object

    Returns the value of the ‘AvailabilityZones’ CloudFormation property.

  • #availability_zone(value) ⇒ Object

    Sets the ‘AvailabilityZones’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘AvailabilityZones’ CloudFormation property to.



38
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 38

property :availability_zone, 'AvailabilityZones', :type => :list

#backup_retention ⇒ Object #backup_retention(value) ⇒ Object

Overloads:

  • #backup_retention ⇒ Object

    Returns the value of the ‘BackupRetentionPeriod’ CloudFormation property.

  • #backup_retention(value) ⇒ Object

    Sets the ‘BackupRetentionPeriod’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘BackupRetentionPeriod’ CloudFormation property to.



39
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 39

property :backup_retention, 'BackupRetentionPeriod'

#cluster_parameter_group_name ⇒ Object #cluster_parameter_group_name(value) ⇒ Object

Overloads:

  • #cluster_parameter_group_name ⇒ Object

    Returns the value of the ‘DBClusterParameterGroupName’ CloudFormation property.

  • #cluster_parameter_group_name(value) ⇒ Object

    Sets the ‘DBClusterParameterGroupName’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘DBClusterParameterGroupName’ CloudFormation property to.



42
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 42

property :cluster_parameter_group_name, 'DBClusterParameterGroupName'

#database_name ⇒ Object #database_name(value) ⇒ Object

Overloads:

  • #database_name ⇒ Object

    Returns the value of the ‘DatabaseName’ CloudFormation property.

  • #database_name(value) ⇒ Object

    Sets the ‘DatabaseName’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘DatabaseName’ CloudFormation property to.



40
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 40

property :database_name, 'DatabaseName'

#engine ⇒ Object #engine(value) ⇒ Object

Overloads:

  • #engine ⇒ Object

    Returns the value of the ‘Engine’ CloudFormation property.

  • #engine(value) ⇒ Object

    Sets the ‘Engine’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘Engine’ CloudFormation property to.



44
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 44

property :engine, 'Engine'

#engine_version ⇒ Object #engine_version(value) ⇒ Object

Overloads:

  • #engine_version ⇒ Object

    Returns the value of the ‘EngineVersion’ CloudFormation property.

  • #engine_version(value) ⇒ Object

    Sets the ‘EngineVersion’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘EngineVersion’ CloudFormation property to.



45
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 45

property :engine_version, 'EngineVersion'

#identifier ⇒ Object #identifier(value) ⇒ Object

Overloads:

  • #identifier ⇒ Object

    Returns the value of the ‘DBClusterIdentifier’ CloudFormation property.

  • #identifier(value) ⇒ Object

    Sets the ‘DBClusterIdentifier’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘DBClusterIdentifier’ CloudFormation property to.



41
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 41

property :identifier, 'DBClusterIdentifier'

#kms_key_id ⇒ Object #kms_key_id(value) ⇒ Object

Overloads:

  • #kms_key_id ⇒ Object

    Returns the value of the ‘KmsKeyId’ CloudFormation property.

  • #kms_key_id(value) ⇒ Object

    Sets the ‘KmsKeyId’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘KmsKeyId’ CloudFormation property to.



46
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 46

property :kms_key_id, 'KmsKeyId'

#master_password ⇒ Object #master_password(value) ⇒ Object

Overloads:

  • #master_password ⇒ Object

    Returns the value of the ‘MasterUserPassword’ CloudFormation property.

  • #master_password(value) ⇒ Object

    Sets the ‘MasterUserPassword’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘MasterUserPassword’ CloudFormation property to.



49
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 49

property :master_password, 'MasterUserPassword'

#master_username(value) ⇒ Object

only specify username and password if you do not specify SnapshotIdentifier



48
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 48

property :master_username, 'MasterUsername'

#port ⇒ Object #port(value) ⇒ Object

Overloads:

  • #port ⇒ Object

    Returns the value of the ‘Port’ CloudFormation property.

  • #port(value) ⇒ Object

    Sets the ‘Port’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘Port’ CloudFormation property to.



50
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 50

property :port, 'Port'

#preferred_backup_window(value) ⇒ Object

backup window must be in the format hh24:mi-hh24:mi, atleast 30 mins long, UTC, cannot conflict with maintenance window.



52
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 52

property :preferred_backup_window, 'PreferredBackupWindow'

#preferred_maintenance_window(value) ⇒ Object

backup window must be in the format ddd:hh24:mi-ddd:hh24:mi, atleast 30 mins long, UTC, cannot conflict with backup window.



54
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 54

property :preferred_maintenance_window, 'PreferredMaintenanceWindow'

#render(*args) ⇒ Object 



61
62
63
64
65
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 61

def render(*args)
  super.tap do |resource|
    render_tags(resource)
  end
end

#replication_source_identifier ⇒ Object #replication_source_identifier(value) ⇒ Object

Overloads:

  • #replication_source_identifier ⇒ Object

    Returns the value of the ‘ReplicationSourceIdentifier’ CloudFormation property.

  • #replication_source_identifier(value) ⇒ Object

    Sets the ‘ReplicationSourceIdentifier’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘ReplicationSourceIdentifier’ CloudFormation property to.



55
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 55

property :replication_source_identifier, 'ReplicationSourceIdentifier'

#snapshot_identifier ⇒ Object #snapshot_identifier(value) ⇒ Object

Overloads:

  • #snapshot_identifier ⇒ Object

    Returns the value of the ‘SnapshotIdentifier’ CloudFormation property.

  • #snapshot_identifier(value) ⇒ Object

    Sets the ‘SnapshotIdentifier’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘SnapshotIdentifier’ CloudFormation property to.



56
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 56

property :snapshot_identifier, 'SnapshotIdentifier'

#storage_encrypted ⇒ Object #storage_encrypted(value) ⇒ Object

Overloads:

  • #storage_encrypted ⇒ Object

    Returns the value of the ‘StorageEncrypted’ CloudFormation property.

  • #storage_encrypted(value) ⇒ Object

    Sets the ‘StorageEncrypted’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘StorageEncrypted’ CloudFormation property to.



57
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 57

property :storage_encrypted, 'StorageEncrypted'

#subnet_group ⇒ Object #subnet_group(value) ⇒ Object

Overloads:

  • #subnet_group ⇒ Object

    Returns the value of the ‘DBSubnetGroupName’ CloudFormation property.

  • #subnet_group(value) ⇒ Object

    Sets the ‘DBSubnetGroupName’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘DBSubnetGroupName’ CloudFormation property to.



43
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 43

property :subnet_group, 'DBSubnetGroupName'

#vpc_security_group ⇒ Object #vpc_security_group(value) ⇒ Object

Overloads:

  • #vpc_security_group ⇒ Object

    Returns the value of the ‘VpcSecurityGroupIds’ CloudFormation property.

  • #vpc_security_group(value) ⇒ Object

    Sets the ‘VpcSecurityGroupIds’ CloudFormation property.

    Parameters:

    • value —

      the value to set the ‘VpcSecurityGroupIds’ CloudFormation property to.



59
 
# File 'lib/convection/model/template/resource/aws_rds_db_cluster.rb', line 59

property :vpc_security_group, 'VpcSecurityGroupIds', :type => :list