Class: AWSCDK::GlobalAccelerator::EndpointGroup

Inherits:
Resource
  • Object
show all
Includes:
IEndpointGroup
Defined in:
global_accelerator/endpoint_group.rb

Overview

EndpointGroup construct.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ EndpointGroup

Returns a new instance of EndpointGroup.

Parameters:



12
13
14
15
16
17
18
 
# File 'global_accelerator/endpoint_group.rb', line 12

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

Class Method Details

.from_endpoint_group_arn(scope, id, endpoint_group_arn) ⇒ AWSCDK::GlobalAccelerator::IEndpointGroup

import from ARN.

Parameters:

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

Returns:



48
49
50
51
52
53
 
# File 'global_accelerator/endpoint_group.rb', line 48

def self.from_endpoint_group_arn(scope, id, endpoint_group_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(endpoint_group_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointGroupArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_globalaccelerator.EndpointGroup", "fromEndpointGroupArn", [scope, id, endpoint_group_arn])
end

.jsii_overridable_methods ⇒ Object 



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

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 },
    :endpoint_group_arn => { kind: :property, name: "endpointGroupArn", is_optional: false },
    :endpoint_group_name => { kind: :property, name: "endpointGroupName", is_optional: false },
    :endpoint_group_ref => { kind: :property, name: "endpointGroupRef", is_optional: false },
    :endpoints => { kind: :property, name: "endpoints", 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_endpoint => { kind: :method, name: "addEndpoint", is_optional: false },
    :connections_peer => { kind: :method, name: "connectionsPeer", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


101
102
103
 
# File 'global_accelerator/endpoint_group.rb', line 101

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

Instance Method Details

#add_endpoint(endpoint) ⇒ void

This method returns an undefined value.

Add an endpoint.

Parameters:



225
226
227
228
 
# File 'global_accelerator/endpoint_group.rb', line 225

def add_endpoint(endpoint)
  Jsii::Type.check_type(endpoint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2xvYmFsYWNjZWxlcmF0b3IuSUVuZHBvaW50In0=")), "endpoint")
  jsii_call_method("addEndpoint", [endpoint])
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:



164
165
166
167
 
# File 'global_accelerator/endpoint_group.rb', line 164

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:



181
182
183
184
 
# File 'global_accelerator/endpoint_group.rb', line 181

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

#connections_peer(id, vpc) ⇒ AWSCDK::EC2::IPeer

Return an object that represents the Accelerator's Security Group.

Uses a Custom Resource to look up the Security Group that Accelerator creates at deploy time. Requires your VPC ID to perform the lookup.

The Security Group will only be created if you enable Client IP Preservation on any of the endpoints.

You cannot manipulate the rules inside this security group, but you can use this security group as a Peer in Connections rules on other constructs.

Parameters:

Returns:



245
246
247
248
249
 
# File 'global_accelerator/endpoint_group.rb', line 245

def connections_peer(id, vpc)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(vpc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklWcGMifQ==")), "vpc")
  jsii_call_method("connectionsPeer", [id, vpc])
end

#endpoint_group_arn ⇒ String

EndpointGroup ARN.

Returns:

  • (String) 


108
109
110
 
# File 'global_accelerator/endpoint_group.rb', line 108

def endpoint_group_arn()
  jsii_get_property("endpointGroupArn")
end

#endpoint_group_name ⇒ String

The name of the endpoint group.

Returns:

  • (String) 


115
116
117
 
# File 'global_accelerator/endpoint_group.rb', line 115

def endpoint_group_name()
  jsii_get_property("endpointGroupName")
end

#endpoint_group_ref ⇒ AWSCDK::Interfaces::AWSGlobalaccelerator::EndpointGroupReference

A reference to a EndpointGroup resource.

Returns:



122
123
124
 
# File 'global_accelerator/endpoint_group.rb', line 122

def endpoint_group_ref()
  jsii_get_property("endpointGroupRef")
end

#endpoints ⇒ Array<AWSCDK::GlobalAccelerator::IEndpoint>

Returns:



127
128
129
 
# File 'global_accelerator/endpoint_group.rb', line 127

def endpoints()
  jsii_get_property("endpoints")
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 'global_accelerator/endpoint_group.rb', line 73

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


187
188
189
 
# File 'global_accelerator/endpoint_group.rb', line 187

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) 


201
202
203
204
205
206
 
# File 'global_accelerator/endpoint_group.rb', line 201

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) 


216
217
218
219
 
# File 'global_accelerator/endpoint_group.rb', line 216

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 'global_accelerator/endpoint_group.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 'global_accelerator/endpoint_group.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 'global_accelerator/endpoint_group.rb', line 94

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


134
135
136
 
# File 'global_accelerator/endpoint_group.rb', line 134

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) 


147
148
149
150
151
152
 
# File 'global_accelerator/endpoint_group.rb', line 147

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