Class: AWSCDK::RDS::CfnDBCluster::DBClusterRoleProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::RDS::CfnDBCluster::DBClusterRoleProperty

Defined in:

rds/cfn_db_cluster.rb

Overview

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html

Instance Attribute Summary

• #feature_name ⇒ String^? readonly

  The name of the feature associated with the AWS Identity and Access Management (IAM) role.

• #role_arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(role_arn:, feature_name: nil) ⇒ DBClusterRoleProperty constructor

  A new instance of DBClusterRoleProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(role_arn:, feature_name: nil) ⇒ DBClusterRoleProperty

Returns a new instance of DBClusterRoleProperty.

Parameters:

• role_arn (String) —

  The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

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

  The name of the feature associated with the AWS Identity and Access Management (IAM) role.

# File 'rds/cfn_db_cluster.rb', line 1425

def initialize(role_arn:, feature_name: nil)
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @feature_name = feature_name
  Jsii::Type.check_type(@feature_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "featureName") unless @feature_name.nil?
end

Instance Attribute Details

#feature_name ⇒ String^? (readonly)

The name of the feature associated with the AWS Identity and Access Management (IAM) role.

IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-featurename

# File 'rds/cfn_db_cluster.rb', line 1443

def feature_name
  @feature_name
end

#role_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-rolearn

# File 'rds/cfn_db_cluster.rb', line 1436

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'rds/cfn_db_cluster.rb', line 1445

def self.jsii_properties
  {
    :role_arn => "roleArn",
    :feature_name => "featureName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'rds/cfn_db_cluster.rb', line 1452

def to_jsii
  result = {}
  result.merge!({
    "roleArn" => @role_arn,
    "featureName" => @feature_name,
  })
  result.compact
end