Class CfnAccelerator
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.globalaccelerator.CfnAccelerator
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:44.016Z")
@Stability(Stable)
public class CfnAccelerator
extends CfnResource
implements IInspectable, ITaggable
The
AWS::GlobalAccelerator::Accelerator
resource is a Global Accelerator resource type that contains information about how you create an accelerator.
An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.globalaccelerator.*; CfnAccelerator cfnAccelerator = CfnAccelerator.Builder.create(this, "MyCfnAccelerator") .name("name") // the properties below are optional .enabled(false) .ipAddresses(List.of("ipAddresses")) .ipAddressType("ipAddressType") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnAccelerator
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAccelerator
(software.amazon.jsii.JsiiObjectRef objRef) CfnAccelerator
(software.constructs.Construct scope, String id, CfnAcceleratorProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the accelerator, such asarn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh
.The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.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.The array of IPv4 addresses in the IP address set.The array of IPv6 addresses in the IP address set.Indicates whether the accelerator is enabled.Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.The IP address type that an accelerator supports.getName()
The name of the accelerator.getTags()
Tag Manager which manages the tags for this resource.Create tags for an accelerator.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setEnabled
(Boolean value) Indicates whether the accelerator is enabled.void
setEnabled
(IResolvable value) Indicates whether the accelerator is enabled.void
setIpAddresses
(List<String> value) Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.void
setIpAddressType
(String value) The IP address type that an accelerator supports.void
The name of the accelerator.void
setTagsRaw
(List<CfnTag> value) Create tags for an accelerator.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnAccelerator
protected CfnAccelerator(software.amazon.jsii.JsiiObjectRef objRef) -
CfnAccelerator
protected CfnAccelerator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnAccelerator
@Stability(Stable) public CfnAccelerator(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAcceleratorProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrAcceleratorArn
The ARN of the accelerator, such asarn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh
. -
getAttrDnsName
The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. -
getAttrDualStackDnsName
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. -
getAttrIpv4Addresses
The array of IPv4 addresses in the IP address set.An IP address set can have a maximum of two IP addresses.
-
getAttrIpv6Addresses
The array of IPv6 addresses in the IP address set.An IP address set can have a maximum of two IP addresses.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getName
The name of the accelerator. -
setName
The name of the accelerator. -
getEnabled
Indicates whether the accelerator is enabled.The value is true or false. The default value is true.
-
setEnabled
Indicates whether the accelerator is enabled.The value is true or false. The default value is true.
-
setEnabled
Indicates whether the accelerator is enabled.The value is true or false. The default value is true.
-
getIpAddresses
Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. -
setIpAddresses
Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. -
getIpAddressType
The IP address type that an accelerator supports. -
setIpAddressType
The IP address type that an accelerator supports. -
getTagsRaw
Create tags for an accelerator. -
setTagsRaw
Create tags for an accelerator.
-