Class: AWSCDK::OpsWorksCM::CfnServer::EngineAttributeProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::OpsWorksCM::CfnServer::EngineAttributeProperty

Defined in:

ops_works_cm/cfn_server.rb

Overview

The EngineAttribute property type specifies administrator credentials for an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

EngineAttribute is a property of the AWS::OpsWorksCM::Server resource type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworkscm-server-engineattribute.html

Instance Attribute Summary

• #name ⇒ String^? readonly

  The name of the engine attribute.

• #value ⇒ String^? readonly

  The value of the engine attribute.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name: nil, value: nil) ⇒ EngineAttributeProperty constructor

  A new instance of EngineAttributeProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name: nil, value: nil) ⇒ EngineAttributeProperty

Returns a new instance of EngineAttributeProperty.

Parameters:

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

  The name of the engine attribute.

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

  The value of the engine attribute.

# File 'ops_works_cm/cfn_server.rb', line 785

def initialize(name: nil, value: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

#name ⇒ String^? (readonly)

The name of the engine attribute.

Attribute name for Chef Automate servers:

• CHEF_AUTOMATE_ADMIN_PASSWORD

Attribute names for Puppet Enterprise servers:

• PUPPET_ADMIN_PASSWORD
• PUPPET_R10K_REMOTE
• PUPPET_R10K_PRIVATE_KEY

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworkscm-server-engineattribute.html#cfn-opsworkscm-server-engineattribute-name

# File 'ops_works_cm/cfn_server.rb', line 806

def name
  @name
end

#value ⇒ String^? (readonly)

The value of the engine attribute.

Attribute value for Chef Automate servers:

• CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. You can generate this key by running the following OpenSSL command on Linux-based computers.

openssl genrsa -out *pivotal_key_file_name* .pem 2048

On Windows-based computers, you can use the PuTTYgen utility to generate a base64-encoded RSA private key. For more information, see PuTTYgen - Key Generator for PuTTY on Windows on SSH.com.

Attribute values for Puppet Enterprise servers:

• PUPPET_ADMIN_PASSWORD : An administrator password that you can use to sign in to the Puppet Enterprise console webpage after the server is online. The password must use between 8 and 32 ASCII characters.
• PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
• PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworkscm-server-engineattribute.html#cfn-opsworkscm-server-engineattribute-value

# File 'ops_works_cm/cfn_server.rb', line 825

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ops_works_cm/cfn_server.rb', line 827

def self.jsii_properties
  {
    :name => "name",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ops_works_cm/cfn_server.rb', line 834

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "value" => @value,
  })
  result.compact
end