Class: AWSCDK::OpsWorksCM::CfnServer

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSOpsworkscm::IServerRef
Defined in:
ops_works_cm/cfn_server.rb

Overview

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 Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnServer

Create a new AWS::OpsWorksCM::Server.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::OpsWorksCM::CfnServerProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'ops_works_cm/cfn_server.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::OpsWorksCM::CfnServerProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3Bzd29ya3NjbS5DZm5TZXJ2ZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_server(resource) ⇒ String

Parameters:

Returns:

  • (String) 


95
96
97
98
 
# File 'ops_works_cm/cfn_server.rb', line 95

def self.arn_for_server(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19vcHN3b3Jrc2NtLklTZXJ2ZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opsworkscm.CfnServer", "arnForServer", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


202
203
204
 
# File 'ops_works_cm/cfn_server.rb', line 202

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_opsworkscm.CfnServer", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_server(x) ⇒ Boolean

Checks whether the given object is a CfnServer.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


104
105
106
107
 
# File 'ops_works_cm/cfn_server.rb', line 104

def self.is_cfn_server(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opsworkscm.CfnServer", "isCfnServer", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'ops_works_cm/cfn_server.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_server_name => { kind: :property, name: "attrServerName", is_optional: false },
    :server_ref => { kind: :property, name: "serverRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :instance_profile_arn => { kind: :property, name: "instanceProfileArn", is_optional: false },
    :instance_type => { kind: :property, name: "instanceType", is_optional: false },
    :service_role_arn => { kind: :property, name: "serviceRoleArn", is_optional: false },
    :associate_public_ip_address => { kind: :property, name: "associatePublicIpAddress", is_optional: true },
    :backup_id => { kind: :property, name: "backupId", is_optional: true },
    :backup_retention_count => { kind: :property, name: "backupRetentionCount", is_optional: true },
    :custom_certificate => { kind: :property, name: "customCertificate", is_optional: true },
    :custom_domain => { kind: :property, name: "customDomain", is_optional: true },
    :custom_private_key => { kind: :property, name: "customPrivateKey", is_optional: true },
    :disable_automated_backup => { kind: :property, name: "disableAutomatedBackup", is_optional: true },
    :engine => { kind: :property, name: "engine", is_optional: true },
    :engine_attributes => { kind: :property, name: "engineAttributes", is_optional: true },
    :engine_model => { kind: :property, name: "engineModel", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :key_pair => { kind: :property, name: "keyPair", is_optional: true },
    :preferred_backup_window => { kind: :property, name: "preferredBackupWindow", is_optional: true },
    :preferred_maintenance_window => { kind: :property, name: "preferredMaintenanceWindow", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :subnet_ids => { kind: :property, name: "subnetIds", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



518
519
520
521
 
# File 'ops_works_cm/cfn_server.rb', line 518

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



530
531
532
533
 
# File 'ops_works_cm/cfn_server.rb', line 530

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



540
541
542
543
 
# File 'ops_works_cm/cfn_server.rb', line 540

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



551
552
553
554
555
 
# File 'ops_works_cm/cfn_server.rb', line 551

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


608
609
610
611
612
 
# File 'ops_works_cm/cfn_server.rb', line 608

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



618
619
620
621
 
# File 'ops_works_cm/cfn_server.rb', line 618

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



630
631
632
633
634
 
# File 'ops_works_cm/cfn_server.rb', line 630

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



643
644
645
646
 
# File 'ops_works_cm/cfn_server.rb', line 643

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



665
666
667
668
669
670
 
# File 'ops_works_cm/cfn_server.rb', line 665

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#associate_public_ip_address ⇒ Boolean, ...

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

Returns:



280
281
282
 
# File 'ops_works_cm/cfn_server.rb', line 280

def associate_public_ip_address()
  jsii_get_property("associatePublicIpAddress")
end

#associate_public_ip_address=(value) ⇒ Object 



284
285
286
287
 
# File 'ops_works_cm/cfn_server.rb', line 284

def associate_public_ip_address=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "associatePublicIpAddress") unless value.nil?
  jsii_set_property("associatePublicIpAddress", value)
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .

Returns:

  • (String) 


209
210
211
 
# File 'ops_works_cm/cfn_server.rb', line 209

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_endpoint ⇒ String

A DNS name that can be used to access the engine.

Example: myserver-asdfghjkl.us-east-1.opsworks.io .

Returns:

  • (String) 


218
219
220
 
# File 'ops_works_cm/cfn_server.rb', line 218

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_server_name ⇒ String

Returns:

  • (String) 


223
224
225
 
# File 'ops_works_cm/cfn_server.rb', line 223

def attr_server_name()
  jsii_get_property("attrServerName")
end

#backup_id ⇒ String?

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

Returns:

  • (String, nil) 


292
293
294
 
# File 'ops_works_cm/cfn_server.rb', line 292

def backup_id()
  jsii_get_property("backupId")
end

#backup_id=(value) ⇒ Object 



296
297
298
299
 
# File 'ops_works_cm/cfn_server.rb', line 296

def backup_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupId") unless value.nil?
  jsii_set_property("backupId", value)
end

#backup_retention_count ⇒ Numeric?

The number of automated backups that you want to keep.

Returns:

  • (Numeric, nil) 


304
305
306
 
# File 'ops_works_cm/cfn_server.rb', line 304

def backup_retention_count()
  jsii_get_property("backupRetentionCount")
end

#backup_retention_count=(value) ⇒ Object 



308
309
310
311
 
# File 'ops_works_cm/cfn_server.rb', line 308

def backup_retention_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "backupRetentionCount") unless value.nil?
  jsii_set_property("backupRetentionCount", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



155
156
157
 
# File 'ops_works_cm/cfn_server.rb', line 155

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


160
161
162
 
# File 'ops_works_cm/cfn_server.rb', line 160

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


674
675
676
677
 
# File 'ops_works_cm/cfn_server.rb', line 674

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


165
166
167
 
# File 'ops_works_cm/cfn_server.rb', line 165

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


172
173
174
 
# File 'ops_works_cm/cfn_server.rb', line 172

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


117
118
119
 
# File 'ops_works_cm/cfn_server.rb', line 117

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_certificate ⇒ String?

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:.

Returns:

  • (String, nil) 


316
317
318
 
# File 'ops_works_cm/cfn_server.rb', line 316

def custom_certificate()
  jsii_get_property("customCertificate")
end

#custom_certificate=(value) ⇒ Object 



320
321
322
323
 
# File 'ops_works_cm/cfn_server.rb', line 320

def custom_certificate=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customCertificate") unless value.nil?
  jsii_set_property("customCertificate", value)
end

#custom_domain ⇒ String?

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 .

Returns:

  • (String, nil) 


328
329
330
 
# File 'ops_works_cm/cfn_server.rb', line 328

def custom_domain()
  jsii_get_property("customDomain")
end

#custom_domain=(value) ⇒ Object 



332
333
334
335
 
# File 'ops_works_cm/cfn_server.rb', line 332

def custom_domain=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customDomain") unless value.nil?
  jsii_set_property("customDomain", value)
end

#custom_private_key ⇒ String?

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 .

Returns:

  • (String, nil) 


340
341
342
 
# File 'ops_works_cm/cfn_server.rb', line 340

def custom_private_key()
  jsii_get_property("customPrivateKey")
end

#custom_private_key=(value) ⇒ Object 



344
345
346
347
 
# File 'ops_works_cm/cfn_server.rb', line 344

def custom_private_key=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customPrivateKey") unless value.nil?
  jsii_set_property("customPrivateKey", value)
end

#disable_automated_backup ⇒ Boolean, ...

Enable or disable scheduled backups.

Returns:



352
353
354
 
# File 'ops_works_cm/cfn_server.rb', line 352

def disable_automated_backup()
  jsii_get_property("disableAutomatedBackup")
end

#disable_automated_backup=(value) ⇒ Object 



356
357
358
359
 
# File 'ops_works_cm/cfn_server.rb', line 356

def disable_automated_backup=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableAutomatedBackup") unless value.nil?
  jsii_set_property("disableAutomatedBackup", value)
end

#engine ⇒ String?

The configuration management engine to use.

Returns:

  • (String, nil) 


364
365
366
 
# File 'ops_works_cm/cfn_server.rb', line 364

def engine()
  jsii_get_property("engine")
end

#engine=(value) ⇒ Object 



368
369
370
371
 
# File 'ops_works_cm/cfn_server.rb', line 368

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

#engine_attributes ⇒ AWSCDK::IResolvable, ...

Optional engine attributes on a specified server.

Returns:



376
377
378
 
# File 'ops_works_cm/cfn_server.rb', line 376

def engine_attributes()
  jsii_get_property("engineAttributes")
end

#engine_attributes=(value) ⇒ Object 



380
381
382
383
 
# File 'ops_works_cm/cfn_server.rb', line 380

def engine_attributes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3Bzd29ya3NjbS5DZm5TZXJ2ZXIuRW5naW5lQXR0cmlidXRlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "engineAttributes") unless value.nil?
  jsii_set_property("engineAttributes", value)
end

#engine_model ⇒ String?

The engine model of the server.

Returns:

  • (String, nil) 


388
389
390
 
# File 'ops_works_cm/cfn_server.rb', line 388

def engine_model()
  jsii_get_property("engineModel")
end

#engine_model=(value) ⇒ Object 



392
393
394
395
 
# File 'ops_works_cm/cfn_server.rb', line 392

def engine_model=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineModel") unless value.nil?
  jsii_set_property("engineModel", value)
end

#engine_version ⇒ String?

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

Returns:

  • (String, nil) 


400
401
402
 
# File 'ops_works_cm/cfn_server.rb', line 400

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



404
405
406
407
 
# File 'ops_works_cm/cfn_server.rb', line 404

def engine_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless value.nil?
  jsii_set_property("engineVersion", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



177
178
179
 
# File 'ops_works_cm/cfn_server.rb', line 177

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



687
688
689
690
691
 
# File 'ops_works_cm/cfn_server.rb', line 687

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



698
699
700
701
 
# File 'ops_works_cm/cfn_server.rb', line 698

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



768
769
770
771
 
# File 'ops_works_cm/cfn_server.rb', line 768

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_profile_arn ⇒ String

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

Returns:

  • (String) 


244
245
246
 
# File 'ops_works_cm/cfn_server.rb', line 244

def instance_profile_arn()
  jsii_get_property("instanceProfileArn")
end

#instance_profile_arn=(value) ⇒ Object 



248
249
250
251
 
# File 'ops_works_cm/cfn_server.rb', line 248

def instance_profile_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceProfileArn")
  jsii_set_property("instanceProfileArn", value)
end

#instance_type ⇒ String

The Amazon EC2 instance type to use.

Returns:

  • (String) 


256
257
258
 
# File 'ops_works_cm/cfn_server.rb', line 256

def instance_type()
  jsii_get_property("instanceType")
end

#instance_type=(value) ⇒ Object 



260
261
262
263
 
# File 'ops_works_cm/cfn_server.rb', line 260

def instance_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceType")
  jsii_set_property("instanceType", value)
end

#key_pair ⇒ String?

The Amazon EC2 key pair to set for the instance.

Returns:

  • (String, nil) 


412
413
414
 
# File 'ops_works_cm/cfn_server.rb', line 412

def key_pair()
  jsii_get_property("keyPair")
end

#key_pair=(value) ⇒ Object 



416
417
418
419
 
# File 'ops_works_cm/cfn_server.rb', line 416

def key_pair=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyPair") unless value.nil?
  jsii_set_property("keyPair", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


129
130
131
 
# File 'ops_works_cm/cfn_server.rb', line 129

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


112
113
114
 
# File 'ops_works_cm/cfn_server.rb', line 112

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



709
710
711
 
# File 'ops_works_cm/cfn_server.rb', line 709

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



716
717
718
 
# File 'ops_works_cm/cfn_server.rb', line 716

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



509
510
511
512
 
# File 'ops_works_cm/cfn_server.rb', line 509

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#preferred_backup_window ⇒ String?

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.

Returns:

  • (String, nil) 


424
425
426
 
# File 'ops_works_cm/cfn_server.rb', line 424

def preferred_backup_window()
  jsii_get_property("preferredBackupWindow")
end

#preferred_backup_window=(value) ⇒ Object 



428
429
430
431
 
# File 'ops_works_cm/cfn_server.rb', line 428

def preferred_backup_window=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredBackupWindow") unless value.nil?
  jsii_set_property("preferredBackupWindow", value)
end

#preferred_maintenance_window ⇒ String?

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

Returns:

  • (String, nil) 


436
437
438
 
# File 'ops_works_cm/cfn_server.rb', line 436

def preferred_maintenance_window()
  jsii_get_property("preferredMaintenanceWindow")
end

#preferred_maintenance_window=(value) ⇒ Object 



440
441
442
443
 
# File 'ops_works_cm/cfn_server.rb', line 440

def preferred_maintenance_window=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredMaintenanceWindow") unless value.nil?
  jsii_set_property("preferredMaintenanceWindow", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


148
149
150
 
# File 'ops_works_cm/cfn_server.rb', line 148

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



727
728
729
730
 
# File 'ops_works_cm/cfn_server.rb', line 727

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


734
735
736
737
 
# File 'ops_works_cm/cfn_server.rb', line 734

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



744
745
746
747
748
 
# File 'ops_works_cm/cfn_server.rb', line 744

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#security_group_ids ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


448
449
450
 
# File 'ops_works_cm/cfn_server.rb', line 448

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



452
453
454
455
 
# File 'ops_works_cm/cfn_server.rb', line 452

def security_group_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless value.nil?
  jsii_set_property("securityGroupIds", value)
end

#server_ref ⇒ AWSCDK::Interfaces::AWSOpsworkscm::ServerReference

A reference to a Server resource.

Returns:



230
231
232
 
# File 'ops_works_cm/cfn_server.rb', line 230

def server_ref()
  jsii_get_property("serverRef")
end

#service_role_arn ⇒ String

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

Returns:

  • (String) 


268
269
270
 
# File 'ops_works_cm/cfn_server.rb', line 268

def service_role_arn()
  jsii_get_property("serviceRoleArn")
end

#service_role_arn=(value) ⇒ Object 



272
273
274
275
 
# File 'ops_works_cm/cfn_server.rb', line 272

def service_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceRoleArn")
  jsii_set_property("serviceRoleArn", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



753
754
755
 
# File 'ops_works_cm/cfn_server.rb', line 753

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



138
139
140
 
# File 'ops_works_cm/cfn_server.rb', line 138

def stack()
  jsii_get_property("stack")
end

#subnet_ids ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


460
461
462
 
# File 'ops_works_cm/cfn_server.rb', line 460

def subnet_ids()
  jsii_get_property("subnetIds")
end

#subnet_ids=(value) ⇒ Object 



464
465
466
467
 
# File 'ops_works_cm/cfn_server.rb', line 464

def subnet_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds") unless value.nil?
  jsii_set_property("subnetIds", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



237
238
239
 
# File 'ops_works_cm/cfn_server.rb', line 237

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



472
473
474
 
# File 'ops_works_cm/cfn_server.rb', line 472

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



476
477
478
479
480
 
# File 'ops_works_cm/cfn_server.rb', line 476

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



485
486
487
 
# File 'ops_works_cm/cfn_server.rb', line 485

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


185
186
187
 
# File 'ops_works_cm/cfn_server.rb', line 185

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


195
196
197
 
# File 'ops_works_cm/cfn_server.rb', line 195

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


759
760
761
762
 
# File 'ops_works_cm/cfn_server.rb', line 759

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


498
499
500
501
502
503
 
# File 'ops_works_cm/cfn_server.rb', line 498

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end