Class: AWSCDK::Lightsail::CfnLoadBalancerTLSCertificate

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSLightsail::ILoadBalancerTLSCertificateRef
Defined in:
lightsail/cfn_load_balancer_tls_certificate.rb

Overview

The AWS::Lightsail::LoadBalancerTlsCertificate resource specifies a TLS certificate that can be used with a Lightsail load balancer.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnLoadBalancerTLSCertificate

Create a new AWS::Lightsail::LoadBalancerTlsCertificate.

Parameters:



17
18
19
20
21
22
23
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 17

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Lightsail::CfnLoadBalancerTLSCertificateProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGlnaHRzYWlsLkNmbkxvYWRCYWxhbmNlclRsc0NlcnRpZmljYXRlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_load_balancer_tls_certificate(resource) ⇒ String

Parameters:

Returns:

  • (String) 


76
77
78
79
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 76

def self.arn_for_load_balancer_tls_certificate(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19saWdodHNhaWwuSUxvYWRCYWxhbmNlclRsc0NlcnRpZmljYXRlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lightsail.CfnLoadBalancerTlsCertificate", "arnForLoadBalancerTlsCertificate", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


183
184
185
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 183

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

.is_cfn_load_balancer_tls_certificate(x) ⇒ Boolean

Checks whether the given object is a CfnLoadBalancerTlsCertificate.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


85
86
87
88
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 85

def self.is_cfn_load_balancer_tls_certificate(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lightsail.CfnLoadBalancerTlsCertificate", "isCfnLoadBalancerTlsCertificate", [x])
end

.jsii_overridable_methods ⇒ Object 



25
26
27
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
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 25

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_load_balancer_tls_certificate_arn => { kind: :property, name: "attrLoadBalancerTlsCertificateArn", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :load_balancer_tls_certificate_ref => { kind: :property, name: "loadBalancerTlsCertificateRef", is_optional: false },
    :certificate_domain_name => { kind: :property, name: "certificateDomainName", is_optional: false },
    :certificate_name => { kind: :property, name: "certificateName", is_optional: false },
    :load_balancer_name => { kind: :property, name: "loadBalancerName", is_optional: false },
    :certificate_alternative_names => { kind: :property, name: "certificateAlternativeNames", is_optional: true },
    :https_redirection_enabled => { kind: :property, name: "httpsRedirectionEnabled", is_optional: true },
    :is_attached => { kind: :property, name: "isAttached", 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.



318
319
320
321
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 318

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:



330
331
332
333
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 330

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:



340
341
342
343
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 340

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:



351
352
353
354
355
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 351

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.


408
409
410
411
412
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 408

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.



418
419
420
421
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 418

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.



430
431
432
433
434
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 430

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:



443
444
445
446
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 443

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:



465
466
467
468
469
470
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 465

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

#attr_load_balancer_tls_certificate_arn ⇒ String

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

Returns:

  • (String) 


190
191
192
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 190

def attr_load_balancer_tls_certificate_arn()
  jsii_get_property("attrLoadBalancerTlsCertificateArn")
end

#attr_status ⇒ String

The validation status of the SSL/TLS certificate.

Valid Values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED | UNKNOWN

Returns:

  • (String) 


199
200
201
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 199

def attr_status()
  jsii_get_property("attrStatus")
end

#certificate_alternative_names ⇒ Array<String>?

An array of alternative domain names and subdomain names for your SSL/TLS certificate.

Returns:

  • (Array<String>, nil) 


249
250
251
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 249

def certificate_alternative_names()
  jsii_get_property("certificateAlternativeNames")
end

#certificate_alternative_names=(value) ⇒ Object 



253
254
255
256
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 253

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

#certificate_domain_name ⇒ String

The domain name for the SSL/TLS certificate.

Returns:

  • (String) 


213
214
215
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 213

def certificate_domain_name()
  jsii_get_property("certificateDomainName")
end

#certificate_domain_name=(value) ⇒ Object 



217
218
219
220
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 217

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

#certificate_name ⇒ String

The name of the SSL/TLS certificate.

Returns:

  • (String) 


225
226
227
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 225

def certificate_name()
  jsii_get_property("certificateName")
end

#certificate_name=(value) ⇒ Object 



229
230
231
232
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 229

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



136
137
138
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 136

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


141
142
143
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 141

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


474
475
476
477
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 474

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}) 


146
147
148
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 146

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


153
154
155
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 153

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


98
99
100
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 98

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



158
159
160
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 158

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:



487
488
489
490
491
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 487

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:



498
499
500
501
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 498

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

#https_redirection_enabled ⇒ Boolean, ...

A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.

Returns:



261
262
263
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 261

def https_redirection_enabled()
  jsii_get_property("httpsRedirectionEnabled")
end

#https_redirection_enabled=(value) ⇒ Object 



265
266
267
268
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 265

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



568
569
570
571
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 568

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

#is_attached ⇒ Boolean, ...

A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.

Returns:



273
274
275
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 273

def is_attached()
  jsii_get_property("isAttached")
end

#is_attached=(value) ⇒ Object 



277
278
279
280
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 277

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

#load_balancer_name ⇒ String

The name of the load balancer that the SSL/TLS certificate is attached to.

Returns:

  • (String) 


237
238
239
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 237

def load_balancer_name()
  jsii_get_property("loadBalancerName")
end

#load_balancer_name=(value) ⇒ Object 



241
242
243
244
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 241

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

#load_balancer_tls_certificate_ref ⇒ AWSCDK::Interfaces::AWSLightsail::LoadBalancerTLSCertificateReference

A reference to a LoadBalancerTlsCertificate resource.

Returns:



206
207
208
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 206

def load_balancer_tls_certificate_ref()
  jsii_get_property("loadBalancerTlsCertificateRef")
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) 


110
111
112
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 110

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


93
94
95
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 93

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:



509
510
511
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 509

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:



516
517
518
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 516

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.



309
310
311
312
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 309

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

#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) 


129
130
131
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 129

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:



527
528
529
530
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 527

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}) 


534
535
536
537
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 534

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:



544
545
546
547
548
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 544

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

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



553
554
555
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 553

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:



119
120
121
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 119

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



285
286
287
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 285

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}) 


166
167
168
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 166

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}) 


176
177
178
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 176

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


559
560
561
562
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 559

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) 


298
299
300
301
302
303
 
# File 'lightsail/cfn_load_balancer_tls_certificate.rb', line 298

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