Module: AWSCDK::GlobalAccelerator::IAccelerator

Includes:
IResource, Interfaces::AWSGlobalaccelerator::IAcceleratorRef
Included in:
Accelerator
Defined in:
global_accelerator/i_accelerator.rb

Overview

The interface of the Accelerator.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'global_accelerator/i_accelerator.rb', line 115

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 },
    :accelerator_ref => { kind: :property, name: "acceleratorRef", is_optional: false },
    :accelerator_arn => { kind: :property, name: "acceleratorArn", is_optional: false },
    :dns_name => { kind: :property, name: "dnsName", is_optional: false },
    :dual_stack_dns_name => { kind: :property, name: "dualStackDnsName", is_optional: true },
    :ipv4_addresses => { kind: :property, name: "ipv4Addresses", is_optional: true },
    :ipv6_addresses => { kind: :property, name: "ipv6Addresses", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#accelerator_arn ⇒ String

The ARN of the accelerator.

Returns:

  • (String) 


48
49
50
 
# File 'global_accelerator/i_accelerator.rb', line 48

def accelerator_arn()
  jsii_get_property("acceleratorArn")
end

#accelerator_ref ⇒ AWSCDK::Interfaces::AWSGlobalaccelerator::AcceleratorReference

A reference to a Accelerator resource.

Returns:



41
42
43
 
# File 'global_accelerator/i_accelerator.rb', line 41

def accelerator_ref()
  jsii_get_property("acceleratorRef")
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:



110
111
112
113
 
# File 'global_accelerator/i_accelerator.rb', line 110

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

#dns_name ⇒ String

The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

Returns:

  • (String) 


55
56
57
 
# File 'global_accelerator/i_accelerator.rb', line 55

def dns_name()
  jsii_get_property("dnsName")
end

#dual_stack_dns_name ⇒ String?

The DNS name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

Returns:

  • (String, nil) 


62
63
64
 
# File 'global_accelerator/i_accelerator.rb', line 62

def dual_stack_dns_name()
  jsii_get_property("dualStackDnsName")
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:



27
28
29
 
# File 'global_accelerator/i_accelerator.rb', line 27

def env()
  jsii_get_property("env")
end

#ipv4_addresses ⇒ Array<String>?

The array of IPv4 addresses in the IP address set.

An IP address set can have a maximum of two IP addresses.

Returns:

  • (Array<String>, nil) 


71
72
73
 
# File 'global_accelerator/i_accelerator.rb', line 71

def ipv4_addresses()
  jsii_get_property("ipv4Addresses")
end

#ipv6_addresses ⇒ Array<String>?

The array of IPv6 addresses in the IP address set.

An IP address set can have a maximum of two IP addresses.

Returns:

  • (Array<String>, nil) 


80
81
82
 
# File 'global_accelerator/i_accelerator.rb', line 80

def ipv6_addresses()
  jsii_get_property("ipv6Addresses")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'global_accelerator/i_accelerator.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'global_accelerator/i_accelerator.rb', line 34

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



91
92
93
94
95
96
 
# File 'global_accelerator/i_accelerator.rb', line 91

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