Class: AWSCDK::APIGateway::CfnDomainName

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSApigateway::IDomainNameRef
Defined in:
api_gateway/cfn_domain_name.rb

Overview

The AWS::ApiGateway::DomainName resource specifies a public custom domain name for your API in API Gateway.

To create a custom domain name for private APIs, use AWS::ApiGateway::DomainNameV2 .

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::ApiGateway::DomainName.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::APIGateway::CfnDomainNameProps, nil) (defaults to: nil) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'api_gateway/cfn_domain_name.rb', line 22

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

Class Method Details

.arn_for_domain_name(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'api_gateway/cfn_domain_name.rb', line 89

def self.arn_for_domain_name(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklEb21haW5OYW1lUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.CfnDomainName", "arnForDomainName", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


222
223
224
 
# File 'api_gateway/cfn_domain_name.rb', line 222

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

.from_domain_name(scope, id, domain_name) ⇒ AWSCDK::Interfaces::AWSApigateway::IDomainNameRef

Creates a new IDomainNameRef from a domainName.

Parameters:

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

Returns:



100
101
102
103
104
105
 
# File 'api_gateway/cfn_domain_name.rb', line 100

def self.from_domain_name(scope, id, domain_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_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.CfnDomainName", "fromDomainName", [scope, id, domain_name])
end

.from_domain_name_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSApigateway::IDomainNameRef

Creates a new IDomainNameRef from an ARN.

Parameters:

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

Returns:



113
114
115
116
117
118
 
# File 'api_gateway/cfn_domain_name.rb', line 113

def self.from_domain_name_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_apigateway.CfnDomainName", "fromDomainNameArn", [scope, id, arn])
end

.is_cfn_domain_name(x) ⇒ Boolean

Checks whether the given object is a CfnDomainName.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


124
125
126
127
 
# File 'api_gateway/cfn_domain_name.rb', line 124

def self.is_cfn_domain_name(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.CfnDomainName", "isCfnDomainName", [x])
end

.jsii_overridable_methods ⇒ Object 



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

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_distribution_domain_name => { kind: :property, name: "attrDistributionDomainName", is_optional: false },
    :attr_distribution_hosted_zone_id => { kind: :property, name: "attrDistributionHostedZoneId", is_optional: false },
    :attr_domain_name_arn => { kind: :property, name: "attrDomainNameArn", is_optional: false },
    :attr_regional_domain_name => { kind: :property, name: "attrRegionalDomainName", is_optional: false },
    :attr_regional_hosted_zone_id => { kind: :property, name: "attrRegionalHostedZoneId", is_optional: false },
    :domain_name_ref => { kind: :property, name: "domainNameRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :certificate_arn => { kind: :property, name: "certificateArn", is_optional: true },
    :domain_name => { kind: :property, name: "domainName", is_optional: true },
    :endpoint_access_mode => { kind: :property, name: "endpointAccessMode", is_optional: true },
    :endpoint_configuration => { kind: :property, name: "endpointConfiguration", is_optional: true },
    :mutual_tls_authentication => { kind: :property, name: "mutualTlsAuthentication", is_optional: true },
    :ownership_verification_certificate_arn => { kind: :property, name: "ownershipVerificationCertificateArn", is_optional: true },
    :regional_certificate_arn => { kind: :property, name: "regionalCertificateArn", is_optional: true },
    :routing_mode => { kind: :property, name: "routingMode", is_optional: true },
    :security_policy => { kind: :property, name: "securityPolicy", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



442
443
444
445
 
# File 'api_gateway/cfn_domain_name.rb', line 442

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:



454
455
456
457
 
# File 'api_gateway/cfn_domain_name.rb', line 454

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:



464
465
466
467
 
# File 'api_gateway/cfn_domain_name.rb', line 464

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:



475
476
477
478
479
 
# File 'api_gateway/cfn_domain_name.rb', line 475

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.


532
533
534
535
536
 
# File 'api_gateway/cfn_domain_name.rb', line 532

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.



542
543
544
545
 
# File 'api_gateway/cfn_domain_name.rb', line 542

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.



554
555
556
557
558
 
# File 'api_gateway/cfn_domain_name.rb', line 554

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:



567
568
569
570
 
# File 'api_gateway/cfn_domain_name.rb', line 567

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:



589
590
591
592
593
594
 
# File 'api_gateway/cfn_domain_name.rb', line 589

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

The Amazon CloudFront distribution domain name that's mapped to the custom domain name.

This is only applicable for endpoints whose type is EDGE .

Example: d111111abcdef8.cloudfront.net

Returns:

  • (String) 


233
234
235
 
# File 'api_gateway/cfn_domain_name.rb', line 233

def attr_distribution_domain_name()
  jsii_get_property("attrDistributionDomainName")
end

#attr_distribution_hosted_zone_id ⇒ String

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.

The only valid value is Z2FDTNDATAQYW2 for all regions.

Returns:

  • (String) 


242
243
244
 
# File 'api_gateway/cfn_domain_name.rb', line 242

def attr_distribution_hosted_zone_id()
  jsii_get_property("attrDistributionHostedZoneId")
end

#attr_domain_name_arn ⇒ String

The ARN of the domain name.

Returns:

  • (String) 


249
250
251
 
# File 'api_gateway/cfn_domain_name.rb', line 249

def attr_domain_name_arn()
  jsii_get_property("attrDomainNameArn")
end

#attr_regional_domain_name ⇒ String

The domain name associated with the regional endpoint for this custom domain name.

You set up this association by adding a DNS record that points the custom domain name to this regional domain name.

Returns:

  • (String) 


258
259
260
 
# File 'api_gateway/cfn_domain_name.rb', line 258

def attr_regional_domain_name()
  jsii_get_property("attrRegionalDomainName")
end

#attr_regional_hosted_zone_id ⇒ String

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

Returns:

  • (String) 


265
266
267
 
# File 'api_gateway/cfn_domain_name.rb', line 265

def attr_regional_hosted_zone_id()
  jsii_get_property("attrRegionalHostedZoneId")
end

#certificate_arn ⇒ String?

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.

Returns:

  • (String, nil) 


286
287
288
 
# File 'api_gateway/cfn_domain_name.rb', line 286

def certificate_arn()
  jsii_get_property("certificateArn")
end

#certificate_arn=(value) ⇒ Object 



290
291
292
293
 
# File 'api_gateway/cfn_domain_name.rb', line 290

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



175
176
177
 
# File 'api_gateway/cfn_domain_name.rb', line 175

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'api_gateway/cfn_domain_name.rb', line 180

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


598
599
600
601
 
# File 'api_gateway/cfn_domain_name.rb', line 598

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


185
186
187
 
# File 'api_gateway/cfn_domain_name.rb', line 185

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


192
193
194
 
# File 'api_gateway/cfn_domain_name.rb', line 192

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


137
138
139
 
# File 'api_gateway/cfn_domain_name.rb', line 137

def creation_stack()
  jsii_get_property("creationStack")
end

#domain_name ⇒ String?

The custom domain name as an API host name, for example, my-api.example.com .

Returns:

  • (String, nil) 


298
299
300
 
# File 'api_gateway/cfn_domain_name.rb', line 298

def domain_name()
  jsii_get_property("domainName")
end

#domain_name=(value) ⇒ Object 



302
303
304
305
 
# File 'api_gateway/cfn_domain_name.rb', line 302

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

#domain_name_ref ⇒ AWSCDK::Interfaces::AWSApigateway::DomainNameReference

A reference to a DomainName resource.

Returns:



272
273
274
 
# File 'api_gateway/cfn_domain_name.rb', line 272

def domain_name_ref()
  jsii_get_property("domainNameRef")
end

#endpoint_access_mode ⇒ String?

The endpoint access mode for your DomainName.

Returns:

  • (String, nil) 


310
311
312
 
# File 'api_gateway/cfn_domain_name.rb', line 310

def endpoint_access_mode()
  jsii_get_property("endpointAccessMode")
end

#endpoint_access_mode=(value) ⇒ Object 



314
315
316
317
 
# File 'api_gateway/cfn_domain_name.rb', line 314

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

#endpoint_configuration ⇒ AWSCDK::IResolvable, ...

The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.

Returns:



322
323
324
 
# File 'api_gateway/cfn_domain_name.rb', line 322

def endpoint_configuration()
  jsii_get_property("endpointConfiguration")
end

#endpoint_configuration=(value) ⇒ Object 



326
327
328
329
330
 
# File 'api_gateway/cfn_domain_name.rb', line 326

def endpoint_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::APIGateway::CfnDomainName::EndpointConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5LkNmbkRvbWFpbk5hbWUuRW5kcG9pbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "endpointConfiguration") unless value.nil?
  jsii_set_property("endpointConfiguration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



197
198
199
 
# File 'api_gateway/cfn_domain_name.rb', line 197

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:



611
612
613
614
615
 
# File 'api_gateway/cfn_domain_name.rb', line 611

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:



622
623
624
625
 
# File 'api_gateway/cfn_domain_name.rb', line 622

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:



692
693
694
695
 
# File 'api_gateway/cfn_domain_name.rb', line 692

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) 


149
150
151
 
# File 'api_gateway/cfn_domain_name.rb', line 149

def logical_id()
  jsii_get_property("logicalId")
end

#mutual_tls_authentication ⇒ AWSCDK::IResolvable, ...

The mutual TLS authentication configuration for a custom domain name.

Returns:



335
336
337
 
# File 'api_gateway/cfn_domain_name.rb', line 335

def mutual_tls_authentication()
  jsii_get_property("mutualTlsAuthentication")
end

#mutual_tls_authentication=(value) ⇒ Object 



339
340
341
342
343
 
# File 'api_gateway/cfn_domain_name.rb', line 339

def mutual_tls_authentication=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::APIGateway::CfnDomainName::MutualTLSAuthenticationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5LkNmbkRvbWFpbk5hbWUuTXV0dWFsVGxzQXV0aGVudGljYXRpb25Qcm9wZXJ0eSJ9XX19")), "mutualTlsAuthentication") unless value.nil?
  jsii_set_property("mutualTlsAuthentication", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


132
133
134
 
# File 'api_gateway/cfn_domain_name.rb', line 132

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:



633
634
635
 
# File 'api_gateway/cfn_domain_name.rb', line 633

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:



640
641
642
 
# File 'api_gateway/cfn_domain_name.rb', line 640

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.



433
434
435
436
 
# File 'api_gateway/cfn_domain_name.rb', line 433

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

#ownership_verification_certificate_arn ⇒ String?

The ARN of the public certificate issued by ACM to validate ownership of your custom domain.

Returns:

  • (String, nil) 


348
349
350
 
# File 'api_gateway/cfn_domain_name.rb', line 348

def ownership_verification_certificate_arn()
  jsii_get_property("ownershipVerificationCertificateArn")
end

#ownership_verification_certificate_arn=(value) ⇒ Object 



352
353
354
355
 
# File 'api_gateway/cfn_domain_name.rb', line 352

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

#ref ⇒ String

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

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

Returns:

  • (String) 


168
169
170
 
# File 'api_gateway/cfn_domain_name.rb', line 168

def ref()
  jsii_get_property("ref")
end

#regional_certificate_arn ⇒ String?

The reference to an AWS -managed certificate that will be used for validating the regional domain name.

Returns:

  • (String, nil) 


360
361
362
 
# File 'api_gateway/cfn_domain_name.rb', line 360

def regional_certificate_arn()
  jsii_get_property("regionalCertificateArn")
end

#regional_certificate_arn=(value) ⇒ Object 



364
365
366
367
 
# File 'api_gateway/cfn_domain_name.rb', line 364

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



651
652
653
654
 
# File 'api_gateway/cfn_domain_name.rb', line 651

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


658
659
660
661
 
# File 'api_gateway/cfn_domain_name.rb', line 658

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:



668
669
670
671
672
 
# File 'api_gateway/cfn_domain_name.rb', line 668

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

#routing_mode ⇒ String?

The routing mode for this domain name.

Returns:

  • (String, nil) 


372
373
374
 
# File 'api_gateway/cfn_domain_name.rb', line 372

def routing_mode()
  jsii_get_property("routingMode")
end

#routing_mode=(value) ⇒ Object 



376
377
378
379
 
# File 'api_gateway/cfn_domain_name.rb', line 376

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

#security_policy ⇒ String?

The Transport Layer Security (TLS) version + cipher suite for this DomainName.

Returns:

  • (String, nil) 


384
385
386
 
# File 'api_gateway/cfn_domain_name.rb', line 384

def security_policy()
  jsii_get_property("securityPolicy")
end

#security_policy=(value) ⇒ Object 



388
389
390
391
 
# File 'api_gateway/cfn_domain_name.rb', line 388

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



677
678
679
 
# File 'api_gateway/cfn_domain_name.rb', line 677

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:



158
159
160
 
# File 'api_gateway/cfn_domain_name.rb', line 158

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



279
280
281
 
# File 'api_gateway/cfn_domain_name.rb', line 279

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The collection of tags.

Returns:



396
397
398
 
# File 'api_gateway/cfn_domain_name.rb', line 396

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



400
401
402
403
404
 
# File 'api_gateway/cfn_domain_name.rb', line 400

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



409
410
411
 
# File 'api_gateway/cfn_domain_name.rb', line 409

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


205
206
207
 
# File 'api_gateway/cfn_domain_name.rb', line 205

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


215
216
217
 
# File 'api_gateway/cfn_domain_name.rb', line 215

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


683
684
685
686
 
# File 'api_gateway/cfn_domain_name.rb', line 683

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) 


422
423
424
425
426
427
 
# File 'api_gateway/cfn_domain_name.rb', line 422

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