Class: AWSCDK::Amplify::CfnDomain

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSAmplify::IDomainRef
Defined in:
amplify/cfn_domain.rb

Overview

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDomain

Create a new AWS::Amplify::Domain.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Amplify::CfnDomainProps) —

    Resource properties.



17
18
19
20
21
22
23
 
# File 'amplify/cfn_domain.rb', line 17

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

Class Method Details

.arn_for_domain(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'amplify/cfn_domain.rb', line 85

def self.arn_for_domain(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hbXBsaWZ5LklEb21haW5SZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_amplify.CfnDomain", "arnForDomain", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


192
193
194
 
# File 'amplify/cfn_domain.rb', line 192

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

.is_cfn_domain(x) ⇒ Boolean

Checks whether the given object is a CfnDomain.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'amplify/cfn_domain.rb', line 94

def self.is_cfn_domain(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_amplify.CfnDomain", "isCfnDomain", [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
73
74
75
76
77
78
79
80
81
 
# File 'amplify/cfn_domain.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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_auto_sub_domain_creation_patterns => { kind: :property, name: "attrAutoSubDomainCreationPatterns", is_optional: false },
    :attr_auto_sub_domain_iam_role => { kind: :property, name: "attrAutoSubDomainIamRole", is_optional: false },
    :attr_certificate => { kind: :property, name: "attrCertificate", is_optional: false },
    :attr_certificate_record => { kind: :property, name: "attrCertificateRecord", is_optional: false },
    :attr_domain_name => { kind: :property, name: "attrDomainName", is_optional: false },
    :attr_domain_status => { kind: :property, name: "attrDomainStatus", is_optional: false },
    :attr_enable_auto_sub_domain => { kind: :property, name: "attrEnableAutoSubDomain", is_optional: false },
    :attr_status_reason => { kind: :property, name: "attrStatusReason", is_optional: false },
    :attr_update_status => { kind: :property, name: "attrUpdateStatus", is_optional: false },
    :domain_ref => { kind: :property, name: "domainRef", is_optional: false },
    :app_id => { kind: :property, name: "appId", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: false },
    :sub_domain_settings => { kind: :property, name: "subDomainSettings", is_optional: false },
    :auto_sub_domain_creation_patterns => { kind: :property, name: "autoSubDomainCreationPatterns", is_optional: true },
    :auto_sub_domain_iam_role => { kind: :property, name: "autoSubDomainIamRole", is_optional: true },
    :certificate_settings => { kind: :property, name: "certificateSettings", is_optional: true },
    :enable_auto_sub_domain => { kind: :property, name: "enableAutoSubDomain", 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.



402
403
404
405
 
# File 'amplify/cfn_domain.rb', line 402

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:



414
415
416
417
 
# File 'amplify/cfn_domain.rb', line 414

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:



424
425
426
427
 
# File 'amplify/cfn_domain.rb', line 424

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:



435
436
437
438
439
 
# File 'amplify/cfn_domain.rb', line 435

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.


492
493
494
495
496
 
# File 'amplify/cfn_domain.rb', line 492

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.



502
503
504
505
 
# File 'amplify/cfn_domain.rb', line 502

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.



514
515
516
517
518
 
# File 'amplify/cfn_domain.rb', line 514

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

#app_id ⇒ String

The unique ID for an Amplify app.

Returns:

  • (String) 


284
285
286
 
# File 'amplify/cfn_domain.rb', line 284

def app_id()
  jsii_get_property("appId")
end

#app_id=(value) ⇒ Object 



288
289
290
291
 
# File 'amplify/cfn_domain.rb', line 288

def app_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appId")
  jsii_set_property("appId", 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:



527
528
529
530
 
# File 'amplify/cfn_domain.rb', line 527

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:



549
550
551
552
553
554
 
# File 'amplify/cfn_domain.rb', line 549

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

ARN for the Domain Association.

Returns:

  • (String) 


199
200
201
 
# File 'amplify/cfn_domain.rb', line 199

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_auto_sub_domain_creation_patterns ⇒ Array<String>

Branch patterns for the automatically created subdomain.

Returns:

  • (Array<String>) 


206
207
208
 
# File 'amplify/cfn_domain.rb', line 206

def attr_auto_sub_domain_creation_patterns()
  jsii_get_property("attrAutoSubDomainCreationPatterns")
end

#attr_auto_sub_domain_iam_role ⇒ String

The IAM service role for the subdomain.

Returns:

  • (String) 


213
214
215
 
# File 'amplify/cfn_domain.rb', line 213

def attr_auto_sub_domain_iam_role()
  jsii_get_property("attrAutoSubDomainIamRole")
end

#attr_certificate ⇒ AWSCDK::IResolvable

Returns:



218
219
220
 
# File 'amplify/cfn_domain.rb', line 218

def attr_certificate()
  jsii_get_property("attrCertificate")
end

#attr_certificate_record ⇒ String

DNS Record for certificate verification.

Returns:

  • (String) 


225
226
227
 
# File 'amplify/cfn_domain.rb', line 225

def attr_certificate_record()
  jsii_get_property("attrCertificateRecord")
end

#attr_domain_name ⇒ String

Name of the domain.

Returns:

  • (String) 


232
233
234
 
# File 'amplify/cfn_domain.rb', line 232

def attr_domain_name()
  jsii_get_property("attrDomainName")
end

#attr_domain_status ⇒ String

Status for the Domain Association.

Returns:

  • (String) 


239
240
241
 
# File 'amplify/cfn_domain.rb', line 239

def attr_domain_status()
  jsii_get_property("attrDomainStatus")
end

#attr_enable_auto_sub_domain ⇒ AWSCDK::IResolvable

Specifies whether the automated creation of subdomains for branches is enabled.

Returns:



246
247
248
 
# File 'amplify/cfn_domain.rb', line 246

def attr_enable_auto_sub_domain()
  jsii_get_property("attrEnableAutoSubDomain")
end

#attr_status_reason ⇒ String

Reason for the current status of the domain.

Returns:

  • (String) 


253
254
255
 
# File 'amplify/cfn_domain.rb', line 253

def attr_status_reason()
  jsii_get_property("attrStatusReason")
end

#attr_update_status ⇒ String

The status of the domain update operation that is currently in progress.

The following list describes the valid update states.

  • REQUESTING_CERTIFICATE - The certificate is in the process of being updated.
  • PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
  • IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
  • PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.
  • AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .
  • UPDATE_COMPLETE - The certificate has been associated with a domain.
  • UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

Returns:

  • (String) 


270
271
272
 
# File 'amplify/cfn_domain.rb', line 270

def attr_update_status()
  jsii_get_property("attrUpdateStatus")
end

#auto_sub_domain_creation_patterns ⇒ Array<String>?

Sets the branch patterns for automatic subdomain creation.

Returns:

  • (Array<String>, nil) 


320
321
322
 
# File 'amplify/cfn_domain.rb', line 320

def auto_sub_domain_creation_patterns()
  jsii_get_property("autoSubDomainCreationPatterns")
end

#auto_sub_domain_creation_patterns=(value) ⇒ Object 



324
325
326
327
 
# File 'amplify/cfn_domain.rb', line 324

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

#auto_sub_domain_iam_role ⇒ String?

The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

Returns:

  • (String, nil) 


332
333
334
 
# File 'amplify/cfn_domain.rb', line 332

def auto_sub_domain_iam_role()
  jsii_get_property("autoSubDomainIamRole")
end

#auto_sub_domain_iam_role=(value) ⇒ Object 



336
337
338
339
 
# File 'amplify/cfn_domain.rb', line 336

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

#certificate_settings ⇒ AWSCDK::IResolvable, ...

The type of SSL/TLS certificate to use for your custom domain.

Returns:



344
345
346
 
# File 'amplify/cfn_domain.rb', line 344

def certificate_settings()
  jsii_get_property("certificateSettings")
end

#certificate_settings=(value) ⇒ Object 



348
349
350
351
352
 
# File 'amplify/cfn_domain.rb', line 348

def certificate_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Amplify::CfnDomain::CertificateSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5LkNmbkRvbWFpbi5DZXJ0aWZpY2F0ZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "certificateSettings") unless value.nil?
  jsii_set_property("certificateSettings", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



145
146
147
 
# File 'amplify/cfn_domain.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 'amplify/cfn_domain.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


558
559
560
561
 
# File 'amplify/cfn_domain.rb', line 558

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


155
156
157
 
# File 'amplify/cfn_domain.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 'amplify/cfn_domain.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


107
108
109
 
# File 'amplify/cfn_domain.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#domain_name ⇒ String

The domain name for the domain association.

Returns:

  • (String) 


296
297
298
 
# File 'amplify/cfn_domain.rb', line 296

def domain_name()
  jsii_get_property("domainName")
end

#domain_name=(value) ⇒ Object 



300
301
302
303
 
# File 'amplify/cfn_domain.rb', line 300

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

#domain_ref ⇒ AWSCDK::Interfaces::AWSAmplify::DomainReference

A reference to a Domain resource.

Returns:



277
278
279
 
# File 'amplify/cfn_domain.rb', line 277

def domain_ref()
  jsii_get_property("domainRef")
end

#enable_auto_sub_domain ⇒ Boolean, ...

Enables the automated creation of subdomains for branches.

Returns:



357
358
359
 
# File 'amplify/cfn_domain.rb', line 357

def enable_auto_sub_domain()
  jsii_get_property("enableAutoSubDomain")
end

#enable_auto_sub_domain=(value) ⇒ Object 



361
362
363
364
 
# File 'amplify/cfn_domain.rb', line 361

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



167
168
169
 
# File 'amplify/cfn_domain.rb', line 167

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:



571
572
573
574
575
 
# File 'amplify/cfn_domain.rb', line 571

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:



582
583
584
585
 
# File 'amplify/cfn_domain.rb', line 582

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:



652
653
654
655
 
# File 'amplify/cfn_domain.rb', line 652

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) 


119
120
121
 
# File 'amplify/cfn_domain.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


102
103
104
 
# File 'amplify/cfn_domain.rb', line 102

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:



593
594
595
 
# File 'amplify/cfn_domain.rb', line 593

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:



600
601
602
 
# File 'amplify/cfn_domain.rb', line 600

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.



393
394
395
396
 
# File 'amplify/cfn_domain.rb', line 393

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) 


138
139
140
 
# File 'amplify/cfn_domain.rb', line 138

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:



611
612
613
614
 
# File 'amplify/cfn_domain.rb', line 611

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


618
619
620
621
 
# File 'amplify/cfn_domain.rb', line 618

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:



628
629
630
631
632
 
# File 'amplify/cfn_domain.rb', line 628

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.



637
638
639
 
# File 'amplify/cfn_domain.rb', line 637

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:



128
129
130
 
# File 'amplify/cfn_domain.rb', line 128

def stack()
  jsii_get_property("stack")
end

#sub_domain_settings ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Amplify::CfnDomain::SubDomainSettingProperty>

The setting for the subdomain.

Returns:



308
309
310
 
# File 'amplify/cfn_domain.rb', line 308

def sub_domain_settings()
  jsii_get_property("subDomainSettings")
end

#sub_domain_settings=(value) ⇒ Object 



312
313
314
315
 
# File 'amplify/cfn_domain.rb', line 312

def sub_domain_settings=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeS5DZm5Eb21haW4uU3ViRG9tYWluU2V0dGluZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "subDomainSettings")
  jsii_set_property("subDomainSettings", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



369
370
371
 
# File 'amplify/cfn_domain.rb', line 369

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


175
176
177
 
# File 'amplify/cfn_domain.rb', line 175

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


185
186
187
 
# File 'amplify/cfn_domain.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


643
644
645
646
 
# File 'amplify/cfn_domain.rb', line 643

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) 


382
383
384
385
386
387
 
# File 'amplify/cfn_domain.rb', line 382

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