Module: AWSCDK::APIGatewayv2::IDomainName

Includes:
IResource, Interfaces::AWSApigatewayv2::IDomainNameRef
Included in:
DomainName
Defined in:
api_gatewayv2/i_domain_name.rb

Overview

Represents an APIGatewayV2 DomainName.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'api_gatewayv2/i_domain_name.rb', line 99

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :domain_name_ref => { kind: :property, name: "domainNameRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :regional_domain_name => { kind: :property, name: "regionalDomainName", is_optional: false },
    :regional_hosted_zone_id => { kind: :property, name: "regionalHostedZoneId", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



94
95
96
97
 
# File 'api_gatewayv2/i_domain_name.rb', line 94

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#domain_name_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::DomainNameReference

A reference to a DomainName resource.

Returns:



43
44
45
 
# File 'api_gatewayv2/i_domain_name.rb', line 43

def domain_name_ref()
  jsii_get_property("domainNameRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



29
30
31
 
# File 'api_gatewayv2/i_domain_name.rb', line 29

def env()
  jsii_get_property("env")
end

#name ⇒ String

The custom domain name.

Returns:

  • (String) 


50
51
52
 
# File 'api_gatewayv2/i_domain_name.rb', line 50

def name()
  jsii_get_property("name")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


14
15
16
 
# File 'api_gatewayv2/i_domain_name.rb', line 14

def node()
  jsii_get_property("node")
end

#regional_domain_name ⇒ String

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

Returns:

  • (String) 


57
58
59
 
# File 'api_gatewayv2/i_domain_name.rb', line 57

def regional_domain_name()
  jsii_get_property("regionalDomainName")
end

#regional_hosted_zone_id ⇒ String

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

Returns:

  • (String) 


64
65
66
 
# File 'api_gatewayv2/i_domain_name.rb', line 64

def regional_hosted_zone_id()
  jsii_get_property("regionalHostedZoneId")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



36
37
38
 
# File 'api_gatewayv2/i_domain_name.rb', line 36

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



75
76
77
78
79
80
 
# File 'api_gatewayv2/i_domain_name.rb', line 75

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