Class CfnVerifiedAccessEndpoint
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.ec2.CfnVerifiedAccessEndpoint
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-12T12:32:01.676Z")
@Stability(Stable)
public class CfnVerifiedAccessEndpoint
extends CfnResource
implements IInspectable, ITaggable
An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to.
It must be attached to an AWS Verified Access group. An AWS Verified Access endpoint must also have an attached access policy before you attached it to a group.
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.ec2.*; CfnVerifiedAccessEndpoint cfnVerifiedAccessEndpoint = CfnVerifiedAccessEndpoint.Builder.create(this, "MyCfnVerifiedAccessEndpoint") .attachmentType("attachmentType") .endpointType("endpointType") .verifiedAccessGroupId("verifiedAccessGroupId") // the properties below are optional .applicationDomain("applicationDomain") .cidrOptions(CidrOptionsProperty.builder() .cidr("cidr") .portRanges(List.of(PortRangeProperty.builder() .fromPort(123) .toPort(123) .build())) .protocol("protocol") .subnetIds(List.of("subnetIds")) .build()) .description("description") .domainCertificateArn("domainCertificateArn") .endpointDomainPrefix("endpointDomainPrefix") .loadBalancerOptions(LoadBalancerOptionsProperty.builder() .loadBalancerArn("loadBalancerArn") .port(123) .portRanges(List.of(PortRangeProperty.builder() .fromPort(123) .toPort(123) .build())) .protocol("protocol") .subnetIds(List.of("subnetIds")) .build()) .networkInterfaceOptions(NetworkInterfaceOptionsProperty.builder() .networkInterfaceId("networkInterfaceId") .port(123) .portRanges(List.of(PortRangeProperty.builder() .fromPort(123) .toPort(123) .build())) .protocol("protocol") .build()) .policyDocument("policyDocument") .policyEnabled(false) .rdsOptions(RdsOptionsProperty.builder() .port(123) .protocol("protocol") .rdsDbClusterArn("rdsDbClusterArn") .rdsDbInstanceArn("rdsDbInstanceArn") .rdsDbProxyArn("rdsDbProxyArn") .rdsEndpoint("rdsEndpoint") .subnetIds(List.of("subnetIds")) .build()) .securityGroupIds(List.of("securityGroupIds")) .sseSpecification(SseSpecificationProperty.builder() .customerManagedKeyEnabled(false) .kmsKeyArn("kmsKeyArn") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnVerifiedAccessEndpoint
.static interface
The options for cidr type endpoint.static interface
Describes the load balancer options when creating an AWS Verified Access endpoint using theload-balancer
type.static interface
Describes the network interface options when creating an AWS Verified Access endpoint using thenetwork-interface
type.static interface
Describes a range of ports.static interface
The options for rds type endpoint.static interface
AWS Verified Access provides server side encryption by default to data at rest using AWS -owned KMS keys.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
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnVerifiedAccessEndpoint
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnVerifiedAccessEndpoint
(software.amazon.jsii.JsiiObjectRef objRef) CfnVerifiedAccessEndpoint
(software.constructs.Construct scope, String id, CfnVerifiedAccessEndpointProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe DNS name for users to reach your application.The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.The creation time.Use this to construct the redirect URI to add to your OIDC provider's allow list.The DNS name generated for the endpoint.The last updated time.The endpoint status.The ID of the Verified Access endpoint.The instance identifier.The options for a CIDR endpoint.A description for the AWS Verified Access endpoint.The ARN of a public TLS/SSL certificate imported into or created with ACM.A custom identifier that is prepended to the DNS name that is generated for the endpoint.The type of AWS Verified Access endpoint.The load balancer details if creating the AWS Verified Access endpoint asload-balancer
type.The options for network-interface type endpoint.The Verified Access policy document.The status of the Verified Access policy.The options for an RDS endpoint.The IDs of the security groups for the endpoint.The options for additional server side encryption.getTags()
Tag Manager which manages the tags for this resource.The tags.The ID of the AWS Verified Access group.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setApplicationDomain
(String value) The DNS name for users to reach your application.void
setAttachmentType
(String value) The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.void
setCidrOptions
(IResolvable value) The options for a CIDR endpoint.void
The options for a CIDR endpoint.void
setDescription
(String value) A description for the AWS Verified Access endpoint.void
setDomainCertificateArn
(String value) The ARN of a public TLS/SSL certificate imported into or created with ACM.void
setEndpointDomainPrefix
(String value) A custom identifier that is prepended to the DNS name that is generated for the endpoint.void
setEndpointType
(String value) The type of AWS Verified Access endpoint.void
The load balancer details if creating the AWS Verified Access endpoint asload-balancer
type.void
The load balancer details if creating the AWS Verified Access endpoint asload-balancer
type.void
The options for network-interface type endpoint.void
The options for network-interface type endpoint.void
setPolicyDocument
(String value) The Verified Access policy document.void
setPolicyEnabled
(Boolean value) The status of the Verified Access policy.void
setPolicyEnabled
(IResolvable value) The status of the Verified Access policy.void
setRdsOptions
(IResolvable value) The options for an RDS endpoint.void
The options for an RDS endpoint.void
setSecurityGroupIds
(List<String> value) The IDs of the security groups for the endpoint.void
setSseSpecification
(IResolvable value) The options for additional server side encryption.void
The options for additional server side encryption.void
setTagsRaw
(List<CfnTag> value) The tags.void
setVerifiedAccessGroupId
(String value) The ID of the AWS Verified Access group.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
-
CfnVerifiedAccessEndpoint
protected CfnVerifiedAccessEndpoint(software.amazon.jsii.JsiiObjectRef objRef) -
CfnVerifiedAccessEndpoint
protected CfnVerifiedAccessEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnVerifiedAccessEndpoint
@Stability(Stable) public CfnVerifiedAccessEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVerifiedAccessEndpointProps 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.
-
getAttrCreationTime
The creation time. -
getAttrDeviceValidationDomain
Use this to construct the redirect URI to add to your OIDC provider's allow list. -
getAttrEndpointDomain
The DNS name generated for the endpoint. -
getAttrLastUpdatedTime
The last updated time. -
getAttrStatus
The endpoint status. -
getAttrVerifiedAccessEndpointId
The ID of the Verified Access endpoint. -
getAttrVerifiedAccessInstanceId
The instance identifier. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAttachmentType
The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application. -
setAttachmentType
The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application. -
getEndpointType
The type of AWS Verified Access endpoint. -
setEndpointType
The type of AWS Verified Access endpoint. -
getVerifiedAccessGroupId
The ID of the AWS Verified Access group. -
setVerifiedAccessGroupId
The ID of the AWS Verified Access group. -
getApplicationDomain
The DNS name for users to reach your application. -
setApplicationDomain
The DNS name for users to reach your application. -
getCidrOptions
The options for a CIDR endpoint. -
setCidrOptions
The options for a CIDR endpoint. -
setCidrOptions
@Stability(Stable) public void setCidrOptions(@Nullable CfnVerifiedAccessEndpoint.CidrOptionsProperty value) The options for a CIDR endpoint. -
getDescription
A description for the AWS Verified Access endpoint. -
setDescription
A description for the AWS Verified Access endpoint. -
getDomainCertificateArn
The ARN of a public TLS/SSL certificate imported into or created with ACM. -
setDomainCertificateArn
The ARN of a public TLS/SSL certificate imported into or created with ACM. -
getEndpointDomainPrefix
A custom identifier that is prepended to the DNS name that is generated for the endpoint. -
setEndpointDomainPrefix
A custom identifier that is prepended to the DNS name that is generated for the endpoint. -
getLoadBalancerOptions
The load balancer details if creating the AWS Verified Access endpoint asload-balancer
type. -
setLoadBalancerOptions
The load balancer details if creating the AWS Verified Access endpoint asload-balancer
type. -
setLoadBalancerOptions
@Stability(Stable) public void setLoadBalancerOptions(@Nullable CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty value) The load balancer details if creating the AWS Verified Access endpoint asload-balancer
type. -
getNetworkInterfaceOptions
The options for network-interface type endpoint. -
setNetworkInterfaceOptions
The options for network-interface type endpoint. -
setNetworkInterfaceOptions
@Stability(Stable) public void setNetworkInterfaceOptions(@Nullable CfnVerifiedAccessEndpoint.NetworkInterfaceOptionsProperty value) The options for network-interface type endpoint. -
getPolicyDocument
The Verified Access policy document. -
setPolicyDocument
The Verified Access policy document. -
getPolicyEnabled
The status of the Verified Access policy. -
setPolicyEnabled
The status of the Verified Access policy. -
setPolicyEnabled
The status of the Verified Access policy. -
getRdsOptions
The options for an RDS endpoint. -
setRdsOptions
The options for an RDS endpoint. -
setRdsOptions
@Stability(Stable) public void setRdsOptions(@Nullable CfnVerifiedAccessEndpoint.RdsOptionsProperty value) The options for an RDS endpoint. -
getSecurityGroupIds
The IDs of the security groups for the endpoint. -
setSecurityGroupIds
The IDs of the security groups for the endpoint. -
getSseSpecification
The options for additional server side encryption. -
setSseSpecification
The options for additional server side encryption. -
setSseSpecification
@Stability(Stable) public void setSseSpecification(@Nullable CfnVerifiedAccessEndpoint.SseSpecificationProperty value) The options for additional server side encryption. -
getTagsRaw
The tags. -
setTagsRaw
The tags.
-