Class: AWSCDK::APIGateway::DomainName

Inherits:
Resource
  • Object
show all
Includes:
IDomainName
Defined in:
api_gateway/domain_name.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ DomainName

Returns a new instance of DomainName.

Parameters:



11
12
13
14
15
16
17
 
# File 'api_gateway/domain_name.rb', line 11

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

Class Method Details

.from_domain_name_attributes(scope, id, attrs) ⇒ AWSCDK::APIGateway::IDomainName

Imports an existing domain name.

Parameters:

Returns:



47
48
49
50
51
52
53
 
# File 'api_gateway/domain_name.rb', line 47

def self.from_domain_name_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::APIGateway::DomainNameAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Eb21haW5OYW1lQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.DomainName", "fromDomainNameAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'api_gateway/domain_name.rb', line 19

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: false },
    :domain_name_alias_domain_name => { kind: :property, name: "domainNameAliasDomainName", is_optional: false },
    :domain_name_alias_hosted_zone_id => { kind: :property, name: "domainNameAliasHostedZoneId", is_optional: false },
    :domain_name_ref => { kind: :property, name: "domainNameRef", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_api_mapping => { kind: :method, name: "addApiMapping", is_optional: false },
    :add_base_path_mapping => { kind: :method, name: "addBasePathMapping", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


101
102
103
 
# File 'api_gateway/domain_name.rb', line 101

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

Instance Method Details

#add_api_mapping(target_stage, options = nil) ⇒ void

This method returns an undefined value.

Maps this domain to an API endpoint.

This uses the ApiMapping from ApiGatewayV2 which supports multi-level paths, but also only supports:

  • SecurityPolicy TLS 1.2 or higher for multi-level base paths (TLS 1.0 is not supported for multi-level paths)
  • EndpointType.REGIONAL

Parameters:

See Also:



235
236
237
238
239
240
 
# File 'api_gateway/domain_name.rb', line 235

def add_api_mapping(target_stage, options = nil)
  Jsii::Type.check_type(target_stage, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklTdGFnZVJlZiJ9")), "targetStage")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::APIMappingOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5BcGlNYXBwaW5nT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addApiMapping", [target_stage, options])
end

#add_base_path_mapping(target_api, options = nil) ⇒ AWSCDK::APIGateway::BasePathMapping

Maps this domain to an API endpoint.

This uses the BasePathMapping from ApiGateway v1 which does not support multi-level paths.

If you need to create a mapping for a multi-level path use add_api_mapping instead.

Parameters:

Returns:



251
252
253
254
255
256
 
# File 'api_gateway/domain_name.rb', line 251

def add_base_path_mapping(target_api, options = nil)
  Jsii::Type.check_type(target_api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklSZXN0QXBpUmVmIn0=")), "targetApi")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::BasePathMappingOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5CYXNlUGF0aE1hcHBpbmdPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("addBasePathMapping", [target_api, options])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



166
167
168
169
 
# File 'api_gateway/domain_name.rb', line 166

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) ⇒ 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:



183
184
185
186
 
# File 'api_gateway/domain_name.rb', line 183

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

The domain name (e.g. example.com).

Returns:

  • (String) 


108
109
110
 
# File 'api_gateway/domain_name.rb', line 108

def domain_name()
  jsii_get_property("domainName")
end

#domain_name_alias_domain_name ⇒ String

The Route53 alias target to use in order to connect a record set to this domain through an alias.

Returns:

  • (String) 


115
116
117
 
# File 'api_gateway/domain_name.rb', line 115

def domain_name_alias_domain_name()
  jsii_get_property("domainNameAliasDomainName")
end

#domain_name_alias_hosted_zone_id ⇒ String

The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

Returns:

  • (String) 


122
123
124
 
# File 'api_gateway/domain_name.rb', line 122

def domain_name_alias_hosted_zone_id()
  jsii_get_property("domainNameAliasHostedZoneId")
end

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

A reference to a DomainName resource.

Returns:



129
130
131
 
# File 'api_gateway/domain_name.rb', line 129

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:



73
74
75
 
# File 'api_gateway/domain_name.rb', line 73

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


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

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


203
204
205
206
207
208
 
# File 'api_gateway/domain_name.rb', line 203

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


218
219
220
221
 
# File 'api_gateway/domain_name.rb', line 218

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


58
59
60
 
# File 'api_gateway/domain_name.rb', line 58

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


87
88
89
 
# File 'api_gateway/domain_name.rb', line 87

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



94
95
96
 
# File 'api_gateway/domain_name.rb', line 94

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


136
137
138
 
# File 'api_gateway/domain_name.rb', line 136

def to_string()
  jsii_call_method("toString", [])
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) 


149
150
151
152
153
154
 
# File 'api_gateway/domain_name.rb', line 149

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