Class: AWSCDK::IoT::CfnDomainConfiguration

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSIot::IDomainConfigurationRef
Defined in:
io_t/cfn_domain_configuration.rb

Overview

Specifies a domain configuration.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnDomainConfiguration

Create a new AWS::IoT::DomainConfiguration.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::IoT::CfnDomainConfigurationProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'io_t/cfn_domain_configuration.rb', line 18

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::IoT::CfnDomainConfigurationProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90LkNmbkRvbWFpbkNvbmZpZ3VyYXRpb25Qcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_domain_configuration(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'io_t/cfn_domain_configuration.rb', line 86

def self.arn_for_domain_configuration(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3QuSURvbWFpbkNvbmZpZ3VyYXRpb25SZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnDomainConfiguration", "arnForDomainConfiguration", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


219
220
221
 
# File 'io_t/cfn_domain_configuration.rb', line 219

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

.from_domain_configuration_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIot::IDomainConfigurationRef

Creates a new IDomainConfigurationRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



97
98
99
100
101
102
 
# File 'io_t/cfn_domain_configuration.rb', line 97

def self.from_domain_configuration_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnDomainConfiguration", "fromDomainConfigurationArn", [scope, id, arn])
end

.from_domain_configuration_name(scope, id, domain_configuration_name) ⇒ AWSCDK::Interfaces::AWSIot::IDomainConfigurationRef

Creates a new IDomainConfigurationRef from a domainConfigurationName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • domain_configuration_name (String)

Returns:



110
111
112
113
114
115
 
# File 'io_t/cfn_domain_configuration.rb', line 110

def self.from_domain_configuration_name(scope, id, domain_configuration_name)
  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(domain_configuration_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainConfigurationName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnDomainConfiguration", "fromDomainConfigurationName", [scope, id, domain_configuration_name])
end

.is_cfn_domain_configuration(x) ⇒ Boolean

Checks whether the given object is a CfnDomainConfiguration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


121
122
123
124
 
# File 'io_t/cfn_domain_configuration.rb', line 121

def self.is_cfn_domain_configuration(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnDomainConfiguration", "isCfnDomainConfiguration", [x])
end

.jsii_overridable_methods ⇒ Object 



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
73
74
75
76
77
78
79
80
81
82
 
# File 'io_t/cfn_domain_configuration.rb', line 26

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_domain_type => { kind: :property, name: "attrDomainType", is_optional: false },
    :attr_server_certificates => { kind: :property, name: "attrServerCertificates", is_optional: false },
    :domain_configuration_ref => { kind: :property, name: "domainConfigurationRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :application_protocol => { kind: :property, name: "applicationProtocol", is_optional: true },
    :authentication_type => { kind: :property, name: "authenticationType", is_optional: true },
    :authorizer_config => { kind: :property, name: "authorizerConfig", is_optional: true },
    :client_certificate_config => { kind: :property, name: "clientCertificateConfig", is_optional: true },
    :domain_configuration_name => { kind: :property, name: "domainConfigurationName", is_optional: true },
    :domain_configuration_status => { kind: :property, name: "domainConfigurationStatus", is_optional: true },
    :domain_name => { kind: :property, name: "domainName", is_optional: true },
    :server_certificate_arns => { kind: :property, name: "serverCertificateArns", is_optional: true },
    :server_certificate_config => { kind: :property, name: "serverCertificateConfig", is_optional: true },
    :service_type => { kind: :property, name: "serviceType", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :tls_config => { kind: :property, name: "tlsConfig", is_optional: true },
    :validation_certificate_arn => { kind: :property, name: "validationCertificateArn", 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.



457
458
459
460
 
# File 'io_t/cfn_domain_configuration.rb', line 457

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:



469
470
471
472
 
# File 'io_t/cfn_domain_configuration.rb', line 469

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:



479
480
481
482
 
# File 'io_t/cfn_domain_configuration.rb', line 479

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:



490
491
492
493
494
 
# File 'io_t/cfn_domain_configuration.rb', line 490

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.


547
548
549
550
551
 
# File 'io_t/cfn_domain_configuration.rb', line 547

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.



557
558
559
560
 
# File 'io_t/cfn_domain_configuration.rb', line 557

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.



569
570
571
572
573
 
# File 'io_t/cfn_domain_configuration.rb', line 569

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

#application_protocol ⇒ String?

An enumerated string that specifies the application-layer protocol.

Returns:

  • (String, nil) 


263
264
265
 
# File 'io_t/cfn_domain_configuration.rb', line 263

def application_protocol()
  jsii_get_property("applicationProtocol")
end

#application_protocol=(value) ⇒ Object 



267
268
269
270
 
# File 'io_t/cfn_domain_configuration.rb', line 267

def application_protocol=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationProtocol") unless value.nil?
  jsii_set_property("applicationProtocol", 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:



582
583
584
585
 
# File 'io_t/cfn_domain_configuration.rb', line 582

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:



604
605
606
607
608
609
 
# File 'io_t/cfn_domain_configuration.rb', line 604

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_arn ⇒ String

The Amazon Resource Name (ARN) of the domain configuration.

Returns:

  • (String) 


226
227
228
 
# File 'io_t/cfn_domain_configuration.rb', line 226

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_domain_type ⇒ String

The type of service delivered by the domain.

Returns:

  • (String) 


233
234
235
 
# File 'io_t/cfn_domain_configuration.rb', line 233

def attr_domain_type()
  jsii_get_property("attrDomainType")
end

#attr_server_certificates ⇒ AWSCDK::IResolvable

The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.

Currently you can specify only one certificate ARN. This value is not required for AWS -managed domains.

Returns:



242
243
244
 
# File 'io_t/cfn_domain_configuration.rb', line 242

def attr_server_certificates()
  jsii_get_property("attrServerCertificates")
end

#authentication_type ⇒ String?

An enumerated string that specifies the authentication type.

Returns:

  • (String, nil) 


275
276
277
 
# File 'io_t/cfn_domain_configuration.rb', line 275

def authentication_type()
  jsii_get_property("authenticationType")
end

#authentication_type=(value) ⇒ Object 



279
280
281
282
 
# File 'io_t/cfn_domain_configuration.rb', line 279

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

#authorizer_config ⇒ AWSCDK::IResolvable, ...

An object that specifies the authorization service for a domain.

Returns:



287
288
289
 
# File 'io_t/cfn_domain_configuration.rb', line 287

def authorizer_config()
  jsii_get_property("authorizerConfig")
end

#authorizer_config=(value) ⇒ Object 



291
292
293
294
295
 
# File 'io_t/cfn_domain_configuration.rb', line 291

def authorizer_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoT::CfnDomainConfiguration::AuthorizerConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuRG9tYWluQ29uZmlndXJhdGlvbi5BdXRob3JpemVyQ29uZmlnUHJvcGVydHkifV19fQ==")), "authorizerConfig") unless value.nil?
  jsii_set_property("authorizerConfig", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



172
173
174
 
# File 'io_t/cfn_domain_configuration.rb', line 172

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


177
178
179
 
# File 'io_t/cfn_domain_configuration.rb', line 177

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


613
614
615
616
 
# File 'io_t/cfn_domain_configuration.rb', line 613

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


182
183
184
 
# File 'io_t/cfn_domain_configuration.rb', line 182

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


189
190
191
 
# File 'io_t/cfn_domain_configuration.rb', line 189

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_certificate_config ⇒ AWSCDK::IResolvable, ...

An object that specifies the client certificate configuration for a domain.

Returns:



300
301
302
 
# File 'io_t/cfn_domain_configuration.rb', line 300

def client_certificate_config()
  jsii_get_property("clientCertificateConfig")
end

#client_certificate_config=(value) ⇒ Object 



304
305
306
307
308
 
# File 'io_t/cfn_domain_configuration.rb', line 304

def client_certificate_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoT::CfnDomainConfiguration::ClientCertificateConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuRG9tYWluQ29uZmlndXJhdGlvbi5DbGllbnRDZXJ0aWZpY2F0ZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "clientCertificateConfig") unless value.nil?
  jsii_set_property("clientCertificateConfig", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


134
135
136
 
# File 'io_t/cfn_domain_configuration.rb', line 134

def creation_stack()
  jsii_get_property("creationStack")
end

#domain_configuration_name ⇒ String?

The name of the domain configuration.

Returns:

  • (String, nil) 


313
314
315
 
# File 'io_t/cfn_domain_configuration.rb', line 313

def domain_configuration_name()
  jsii_get_property("domainConfigurationName")
end

#domain_configuration_name=(value) ⇒ Object 



317
318
319
320
 
# File 'io_t/cfn_domain_configuration.rb', line 317

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

#domain_configuration_ref ⇒ AWSCDK::Interfaces::AWSIot::DomainConfigurationReference

A reference to a DomainConfiguration resource.

Returns:



249
250
251
 
# File 'io_t/cfn_domain_configuration.rb', line 249

def domain_configuration_ref()
  jsii_get_property("domainConfigurationRef")
end

#domain_configuration_status ⇒ String?

The status to which the domain configuration should be updated.

Returns:

  • (String, nil) 


325
326
327
 
# File 'io_t/cfn_domain_configuration.rb', line 325

def domain_configuration_status()
  jsii_get_property("domainConfigurationStatus")
end

#domain_configuration_status=(value) ⇒ Object 



329
330
331
332
 
# File 'io_t/cfn_domain_configuration.rb', line 329

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

#domain_name ⇒ String?

The name of the domain.

Returns:

  • (String, nil) 


337
338
339
 
# File 'io_t/cfn_domain_configuration.rb', line 337

def domain_name()
  jsii_get_property("domainName")
end

#domain_name=(value) ⇒ Object 



341
342
343
344
 
# File 'io_t/cfn_domain_configuration.rb', line 341

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



194
195
196
 
# File 'io_t/cfn_domain_configuration.rb', line 194

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:



626
627
628
629
630
 
# File 'io_t/cfn_domain_configuration.rb', line 626

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:



637
638
639
640
 
# File 'io_t/cfn_domain_configuration.rb', line 637

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:



707
708
709
710
 
# File 'io_t/cfn_domain_configuration.rb', line 707

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


146
147
148
 
# File 'io_t/cfn_domain_configuration.rb', line 146

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


129
130
131
 
# File 'io_t/cfn_domain_configuration.rb', line 129

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:



648
649
650
 
# File 'io_t/cfn_domain_configuration.rb', line 648

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:



655
656
657
 
# File 'io_t/cfn_domain_configuration.rb', line 655

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.



448
449
450
451
 
# File 'io_t/cfn_domain_configuration.rb', line 448

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) 


165
166
167
 
# File 'io_t/cfn_domain_configuration.rb', line 165

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:



666
667
668
669
 
# File 'io_t/cfn_domain_configuration.rb', line 666

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


673
674
675
676
 
# File 'io_t/cfn_domain_configuration.rb', line 673

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:



683
684
685
686
687
 
# File 'io_t/cfn_domain_configuration.rb', line 683

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

#server_certificate_arns ⇒ Array<String>?

The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.

Returns:

  • (Array<String>, nil) 


349
350
351
 
# File 'io_t/cfn_domain_configuration.rb', line 349

def server_certificate_arns()
  jsii_get_property("serverCertificateArns")
end

#server_certificate_arns=(value) ⇒ Object 



353
354
355
356
 
# File 'io_t/cfn_domain_configuration.rb', line 353

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

#server_certificate_config ⇒ AWSCDK::IResolvable, ...

The server certificate configuration.

Returns:



361
362
363
 
# File 'io_t/cfn_domain_configuration.rb', line 361

def server_certificate_config()
  jsii_get_property("serverCertificateConfig")
end

#server_certificate_config=(value) ⇒ Object 



365
366
367
368
369
 
# File 'io_t/cfn_domain_configuration.rb', line 365

def server_certificate_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoT::CfnDomainConfiguration::ServerCertificateConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuRG9tYWluQ29uZmlndXJhdGlvbi5TZXJ2ZXJDZXJ0aWZpY2F0ZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "serverCertificateConfig") unless value.nil?
  jsii_set_property("serverCertificateConfig", value)
end

#service_type ⇒ String?

The type of service delivered by the endpoint.

Returns:

  • (String, nil) 


374
375
376
 
# File 'io_t/cfn_domain_configuration.rb', line 374

def service_type()
  jsii_get_property("serviceType")
end

#service_type=(value) ⇒ Object 



378
379
380
381
 
# File 'io_t/cfn_domain_configuration.rb', line 378

def service_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceType") unless value.nil?
  jsii_set_property("serviceType", 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.



692
693
694
 
# File 'io_t/cfn_domain_configuration.rb', line 692

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:



155
156
157
 
# File 'io_t/cfn_domain_configuration.rb', line 155

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



256
257
258
 
# File 'io_t/cfn_domain_configuration.rb', line 256

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Metadata which can be used to manage the domain configuration.

Returns:



386
387
388
 
# File 'io_t/cfn_domain_configuration.rb', line 386

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



390
391
392
393
394
 
# File 'io_t/cfn_domain_configuration.rb', line 390

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

#tls_config ⇒ AWSCDK::IResolvable, ...

An object that specifies the TLS configuration for a domain.

Returns:



399
400
401
 
# File 'io_t/cfn_domain_configuration.rb', line 399

def tls_config()
  jsii_get_property("tlsConfig")
end

#tls_config=(value) ⇒ Object 



403
404
405
406
407
 
# File 'io_t/cfn_domain_configuration.rb', line 403

def tls_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoT::CfnDomainConfiguration::TLSConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuRG9tYWluQ29uZmlndXJhdGlvbi5UbHNDb25maWdQcm9wZXJ0eSJ9XX19")), "tlsConfig") unless value.nil?
  jsii_set_property("tlsConfig", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



424
425
426
 
# File 'io_t/cfn_domain_configuration.rb', line 424

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


202
203
204
 
# File 'io_t/cfn_domain_configuration.rb', line 202

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


212
213
214
 
# File 'io_t/cfn_domain_configuration.rb', line 212

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


698
699
700
701
 
# File 'io_t/cfn_domain_configuration.rb', line 698

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

#validation_certificate_arn ⇒ String?

The certificate used to validate the server certificate and prove domain name ownership.

Returns:

  • (String, nil) 


412
413
414
 
# File 'io_t/cfn_domain_configuration.rb', line 412

def validation_certificate_arn()
  jsii_get_property("validationCertificateArn")
end

#validation_certificate_arn=(value) ⇒ Object 



416
417
418
419
 
# File 'io_t/cfn_domain_configuration.rb', line 416

def validation_certificate_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "validationCertificateArn") unless value.nil?
  jsii_set_property("validationCertificateArn", value)
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) 


437
438
439
440
441
442
 
# File 'io_t/cfn_domain_configuration.rb', line 437

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