java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.opsworkscm.CfnServerProps.Jsii$Proxy

All Implemented Interfaces:: CfnServerProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: CfnServerProps

@Stability(Stable) @Internal public static final class CfnServerProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnServerProps

An implementation for CfnServerProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.opsworkscm.CfnServerProps
CfnServerProps.Builder, CfnServerProps.Jsii$Proxy
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(CfnServerProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnServerProps.Builder.

protected

Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.
Method Summary

Modifier and Type

Method

Description

com.fasterxml.jackson.databind.JsonNode

$jsii$toJson()

final boolean

equals(Object o)

final Object

getAssociatePublicIpAddress()

Associate a public IP address with a server that you are launching.

final String

getBackupId()

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

final Number

getBackupRetentionCount()

The number of automated backups that you want to keep.

final String

getCustomCertificate()

Supported on servers running Chef Automate 2.0 only.

final String

getCustomDomain()

Supported on servers running Chef Automate 2.0 only.

final String

getCustomPrivateKey()

Supported on servers running Chef Automate 2.0 only.

final Object

getDisableAutomatedBackup()

Enable or disable scheduled backups.

final String

getEngine()

The configuration management engine to use.

final Object

getEngineAttributes()

Optional engine attributes on a specified server.

final String

getEngineModel()

The engine model of the server.

final String

getEngineVersion()

The major release version of the engine that you want to use.

final String

getInstanceProfileArn()

The ARN of the instance profile that your Amazon EC2 instances use.

final String

getInstanceType()

The Amazon EC2 instance type to use.

final String

getKeyPair()

The Amazon EC2 key pair to set for the instance.

final String

getPreferredBackupWindow()

The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.

final String

getPreferredMaintenanceWindow()

The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.

final List<String>

getSecurityGroupIds()

A list of security group IDs to attach to the Amazon EC2 instance.

final String

getServiceRoleArn()

The service role that the AWS OpsWorks CM service backend uses to work with your account.

final List<String>

getSubnetIds()

The IDs of subnets in which to launch the server EC2 instance.

final List<CfnTag>

getTags()

A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

final int

hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Jsii$Proxy
  
  protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
  
  Constructor that initializes the object based on values retrieved from the JsiiObject.
  
  Parameters:
  
  objRef - Reference to the JSII managed object.
- Jsii$Proxy
  
  protected Jsii$Proxy(CfnServerProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the CfnServerProps.Builder.
Method Details
- getInstanceProfileArn
  
  public final String getInstanceProfileArn()
  
  Description copied from interface: CfnServerProps
  
  The ARN of the instance profile that your Amazon EC2 instances use.
  Specified by:
  
  getInstanceProfileArn in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-instanceprofilearn
- getInstanceType
  
  public final String getInstanceType()
  
  Description copied from interface: CfnServerProps
  
  The Amazon EC2 instance type to use.
  For example, m5.large .
  Specified by:
  
  getInstanceType in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-instancetype
- getServiceRoleArn
  
  public final String getServiceRoleArn()
  
  Description copied from interface: CfnServerProps
  
  The service role that the AWS OpsWorks CM service backend uses to work with your account.
  Specified by:
  
  getServiceRoleArn in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-servicerolearn
- getAssociatePublicIpAddress
  
  public final Object getAssociatePublicIpAddress()
  
  Description copied from interface: CfnServerProps
  
  Associate a public IP address with a server that you are launching.
  Valid values are true or false . The default value is true .
  Returns union: either Boolean or IResolvable
  Specified by:
  
  getAssociatePublicIpAddress in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-associatepublicipaddress
- getBackupId
  
  public final String getBackupId()
  
  Description copied from interface: CfnServerProps
  
  If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
  Specified by:
  
  getBackupId in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-backupid
- getBackupRetentionCount
  
  public final Number getBackupRetentionCount()
  
  Description copied from interface: CfnServerProps
  
  The number of automated backups that you want to keep.
  Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
  Specified by:
  
  getBackupRetentionCount in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-backupretentioncount
- getCustomCertificate
  
  public final String getCustomCertificate()
  
  Description copied from interface: CfnServerProps
  Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey . The following are requirements for the CustomCertificate value:.
  
  You can provide either a self-signed, custom certificate, or the full certificate chain.
  
  The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
  
  The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
  
  The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
  
  The certificate must match the value of CustomPrivateKey .
  Specified by:
  
  getCustomCertificate in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customcertificate
- getCustomDomain
  
  public final String getCustomDomain()
  
  Description copied from interface: CfnServerProps
  
  Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as https://aws.my-company.com . To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey .
  Specified by:
  
  getCustomDomain in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customdomain
- getCustomPrivateKey
  
  public final String getCustomPrivateKey()
  
  Description copied from interface: CfnServerProps
  
  Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate .
  Specified by:
  
  getCustomPrivateKey in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customprivatekey
- getDisableAutomatedBackup
  
  public final Object getDisableAutomatedBackup()
  
  Description copied from interface: CfnServerProps
  
  Enable or disable scheduled backups.
  Valid values are true or false . The default value is true .
  Returns union: either Boolean or IResolvable
  Specified by:
  
  getDisableAutomatedBackup in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-disableautomatedbackup
- getEngine
  
  public final String getEngine()
  
  Description copied from interface: CfnServerProps
  
  The configuration management engine to use.
  Valid values include ChefAutomate and Puppet .
  Specified by:
  
  getEngine in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engine
- getEngineAttributes
  
  public final Object getEngineAttributes()
  
  Description copied from interface: CfnServerProps
  Optional engine attributes on a specified server.
  Attributes accepted in a Chef createServer request: - CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. When you are specifying the value of CHEF_AUTOMATE_PIVOTAL_KEY as a parameter in the AWS CloudFormation console, you must add newline ( \n ) characters at the end of each line of the pivotal key value.
  
  CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.
  
  Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use 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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnServer.EngineAttributeProperty>
  Specified by:
  
  getEngineAttributes in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engineattributes
- getEngineModel
  
  public final String getEngineModel()
  
  Description copied from interface: CfnServerProps
  
  The engine model of the server.
  Valid values in this release include Monolithic for Puppet and Single for Chef.
  Specified by:
  
  getEngineModel in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-enginemodel
- getEngineVersion
  
  public final String getEngineVersion()
  
  Description copied from interface: CfnServerProps
  
  The major release version of the engine that you want to use.
  For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .
  Specified by:
  
  getEngineVersion in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engineversion
- getKeyPair
  
  public final String getKeyPair()
  
  Description copied from interface: CfnServerProps
  
  The Amazon EC2 key pair to set for the instance.
  This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.
  Specified by:
  
  getKeyPair in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-keypair
- getPreferredBackupWindow
  
  public final String getPreferredBackupWindow()
  
  Description copied from interface: CfnServerProps
  The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.
  Valid values must be specified in one of the following formats:
  
  HH:MM for daily backups
  
  DDD:HH:MM for weekly backups
  
  MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.
  Example: 08:00 , which represents a daily start time of 08:00 UTC.
  Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
  Specified by:
  
  getPreferredBackupWindow in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-preferredbackupwindow
- getPreferredMaintenanceWindow
  
  public final String getPreferredMaintenanceWindow()
  
  Description copied from interface: CfnServerProps
  
  The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
  Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.
  Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
  Specified by:
  
  getPreferredMaintenanceWindow in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-preferredmaintenancewindow
- getSecurityGroupIds
  
  public final List<String> getSecurityGroupIds()
  
  Description copied from interface: CfnServerProps
  
  A list of security group IDs to attach to the Amazon EC2 instance.
  If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds .
  If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
  Specified by:
  
  getSecurityGroupIds in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-securitygroupids
- getSubnetIds
  
  public final List<String> getSubnetIds()
  
  Description copied from interface: CfnServerProps
  
  The IDs of subnets in which to launch the server EC2 instance.
  Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
  EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
  For more information about supported Amazon EC2 platforms, see Supported Platforms .
  Specified by:
  
  getSubnetIds in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-subnetids
- getTags
  
  public final List<CfnTag> getTags()
  
  Description copied from interface: CfnServerProps
  A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.
  
  The key cannot be empty.
  
  The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: `+ - = . _ : /
  Specified by:
  
  getTags in interface CfnServerProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-tags
- $jsii$toJson
  
  @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
  
  Specified by:
  
  $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
- equals
  
  public final boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class CfnServerProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.opsworkscm.CfnServerProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getInstanceProfileArn

getInstanceType

getServiceRoleArn

getAssociatePublicIpAddress

getBackupId

getBackupRetentionCount

getCustomCertificate

getCustomDomain

getCustomPrivateKey

getDisableAutomatedBackup

getEngine

getEngineAttributes

getEngineModel

getEngineVersion

getKeyPair

getPreferredBackupWindow

getPreferredMaintenanceWindow

getSecurityGroupIds

getSubnetIds

getTags

$jsii$toJson

equals

hashCode