CfnServerPropsMixin

class aws_cdk.mixins_preview.aws_opsworkscm.mixins.CfnServerPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::OpsWorksCM::Server resource creates an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise configuration management server.

For more information, see Create a Chef Automate Server in CloudFormation or Create a Puppet Enterprise Master in CloudFormation in the OpsWorks User Guide , and CreateServer in the AWS OpsWorks CM API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html
CloudformationResource:: AWS::OpsWorksCM::Server
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_opsworkscm import mixins as opsworkscm_mixins

cfn_server_props_mixin = opsworkscm_mixins.CfnServerPropsMixin(opsworkscm_mixins.CfnServerMixinProps(
    associate_public_ip_address=False,
    backup_id="backupId",
    backup_retention_count=123,
    custom_certificate="customCertificate",
    custom_domain="customDomain",
    custom_private_key="customPrivateKey",
    disable_automated_backup=False,
    engine="engine",
    engine_attributes=[opsworkscm_mixins.CfnServerPropsMixin.EngineAttributeProperty(
        name="name",
        value="value"
    )],
    engine_model="engineModel",
    engine_version="engineVersion",
    instance_profile_arn="instanceProfileArn",
    instance_type="instanceType",
    key_pair="keyPair",
    preferred_backup_window="preferredBackupWindow",
    preferred_maintenance_window="preferredMaintenanceWindow",
    security_group_ids=["securityGroupIds"],
    service_role_arn="serviceRoleArn",
    subnet_ids=["subnetIds"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::OpsWorksCM::Server.

Parameters:

props (Union[CfnServerMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['associatePublicIpAddress', 'backupId', 'backupRetentionCount', 'customCertificate', 'customDomain', 'customPrivateKey', 'disableAutomatedBackup', 'engine', 'engineAttributes', 'engineModel', 'engineVersion', 'instanceProfileArn', 'instanceType', 'keyPair', 'preferredBackupWindow', 'preferredMaintenanceWindow', 'securityGroupIds', 'serviceRoleArn', 'subnetIds', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EngineAttributeProperty

class CfnServerPropsMixin.EngineAttributeProperty(*, name=None, value=None)

Bases: object

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.

Parameters:

name (Optional[str]) – 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
value (Optional[str]) – 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.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_opsworkscm import mixins as opsworkscm_mixins

engine_attribute_property = opsworkscm_mixins.CfnServerPropsMixin.EngineAttributeProperty(
    name="name",
    value="value"
)

Attributes

name

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

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

value

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.

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