Class: AWSCDK::APIGateway::CfnDomainNameV2

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSApigateway::IDomainNameV2Ref
Defined in:
api_gateway/cfn_domain_name_v2.rb

Overview

The AWS::ApiGateway::DomainNameV2 resource specifies a custom domain name for your private APIs in API Gateway.

You can use a private custom domain name to provide a URL for your private API that's more intuitive and easier to recall.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::ApiGateway::DomainNameV2.

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::CfnDomainNameV2Props, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 20

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


182
183
184
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 182

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

.is_cfn_domain_name_v2(x) ⇒ Boolean

Checks whether the given object is a CfnDomainNameV2.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


84
85
86
87
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 84

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

.jsii_overridable_methods ⇒ Object 



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

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_domain_name_arn => { kind: :property, name: "attrDomainNameArn", is_optional: false },
    :attr_domain_name_id => { kind: :property, name: "attrDomainNameId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :domain_name_v2_ref => { kind: :property, name: "domainNameV2Ref", is_optional: false },
    :policy => { kind: :property, name: "policy", 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 },
    :routing_mode => { kind: :property, name: "routingMode", is_optional: true },
    :security_policy => { kind: :property, name: "securityPolicy", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



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

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:



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

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:



370
371
372
373
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 370

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:



381
382
383
384
385
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 381

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.


438
439
440
441
442
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 438

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.



448
449
450
451
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 448

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.



460
461
462
463
464
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 460

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:



473
474
475
476
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 473

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:



495
496
497
498
499
500
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 495

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

The ARN of the domain name.

Returns:

  • (String) 


189
190
191
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 189

def attr_domain_name_arn()
  jsii_get_property("attrDomainNameArn")
end

#attr_domain_name_id ⇒ String

The domain name ID.

Returns:

  • (String) 


196
197
198
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 196

def attr_domain_name_id()
  jsii_get_property("attrDomainNameId")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



203
204
205
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 203

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#certificate_arn ⇒ String?

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

Returns:

  • (String, nil) 


229
230
231
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 229

def certificate_arn()
  jsii_get_property("certificateArn")
end

#certificate_arn=(value) ⇒ Object 



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

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:



135
136
137
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 135

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


140
141
142
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 140

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


504
505
506
507
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 504

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


145
146
147
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 145

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


152
153
154
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 152

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


97
98
99
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 97

def creation_stack()
  jsii_get_property("creationStack")
end

#domain_name ⇒ String?

Represents a custom domain name as a user-friendly host name of an API (RestApi).

Returns:

  • (String, nil) 


241
242
243
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 241

def domain_name()
  jsii_get_property("domainName")
end

#domain_name=(value) ⇒ Object 



245
246
247
248
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 245

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_v2_ref ⇒ AWSCDK::Interfaces::AWSApigateway::DomainNameV2Reference

A reference to a DomainNameV2 resource.

Returns:



210
211
212
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 210

def domain_name_v2_ref()
  jsii_get_property("domainNameV2Ref")
end

#endpoint_access_mode ⇒ String?

The endpoint access mode for your DomainName.

Returns:

  • (String, nil) 


253
254
255
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 253

def endpoint_access_mode()
  jsii_get_property("endpointAccessMode")
end

#endpoint_access_mode=(value) ⇒ Object 



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

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 to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

Returns:



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

def endpoint_configuration()
  jsii_get_property("endpointConfiguration")
end

#endpoint_configuration=(value) ⇒ Object 



269
270
271
272
273
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 269

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



157
158
159
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 157

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:



517
518
519
520
521
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 517

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:



528
529
530
531
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 528

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:



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

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) 


109
110
111
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 109

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


92
93
94
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 92

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:



539
540
541
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 539

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:



546
547
548
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 546

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.



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

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

#policy ⇒ Object

A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration.

Returns:

  • (Object) 


217
218
219
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 217

def policy()
  jsii_get_property("policy")
end

#policy=(value) ⇒ Object 



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

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


128
129
130
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 128

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:



557
558
559
560
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 557

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


564
565
566
567
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 564

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:



574
575
576
577
578
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 574

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) 


278
279
280
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 278

def routing_mode()
  jsii_get_property("routingMode")
end

#routing_mode=(value) ⇒ Object 



282
283
284
285
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 282

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) 


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

def security_policy()
  jsii_get_property("securityPolicy")
end

#security_policy=(value) ⇒ Object 



294
295
296
297
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 294

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.



583
584
585
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 583

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:



118
119
120
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 118

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The collection of tags.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



306
307
308
309
310
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 306

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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


165
166
167
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 165

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


589
590
591
592
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 589

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) 


328
329
330
331
332
333
 
# File 'api_gateway/cfn_domain_name_v2.rb', line 328

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