Package software.amazon.awscdk.services.ec2

Class CfnVerifiedAccessEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ec2.CfnVerifiedAccessEndpoint
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.193Z") @Stability(Stable) public class CfnVerifiedAccessEndpoint extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::VerifiedAccessEndpoint.

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")
         .applicationDomain("applicationDomain")
         .attachmentType("attachmentType")
         .domainCertificateArn("domainCertificateArn")
         .endpointDomainPrefix("endpointDomainPrefix")
         .endpointType("endpointType")
         .verifiedAccessGroupId("verifiedAccessGroupId")
         // the properties below are optional
         .description("description")
         .loadBalancerOptions(LoadBalancerOptionsProperty.builder()
                 .loadBalancerArn("loadBalancerArn")
                 .port(123)
                 .protocol("protocol")
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .networkInterfaceOptions(NetworkInterfaceOptionsProperty.builder()
                 .networkInterfaceId("networkInterfaceId")
                 .port(123)
                 .protocol("protocol")
                 .build())
         .policyDocument("policyDocument")
         .policyEnabled(false)
         .securityGroupIds(List.of("securityGroupIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 Construct scope, @NotNull String id, @NotNull CfnVerifiedAccessEndpointProps props)
      Create a new AWS::EC2::VerifiedAccessEndpoint.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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 class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The creation time.

    • getAttrDeviceValidationDomain

      @Stability(Stable) @NotNull public String getAttrDeviceValidationDomain()
      Use this to construct the redirect URI to add to your OIDC provider's allow list.

    • getAttrEndpointDomain

      @Stability(Stable) @NotNull public String getAttrEndpointDomain()
      The DNS name generated for the endpoint.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The last updated time.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The endpoint status.

    • getAttrVerifiedAccessEndpointId

      @Stability(Stable) @NotNull public String getAttrVerifiedAccessEndpointId()
      The ID of the Verified Access endpoint.

    • getAttrVerifiedAccessInstanceId

      @Stability(Stable) @NotNull public String getAttrVerifiedAccessInstanceId()
      The instance identifier.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags.

    • getApplicationDomain

      @Stability(Stable) @NotNull public String getApplicationDomain()
      The DNS name for users to reach your application.

    • setApplicationDomain

      @Stability(Stable) public void setApplicationDomain(@NotNull String value)
      The DNS name for users to reach your application.

    • getAttachmentType

      @Stability(Stable) @NotNull public String getAttachmentType()
      The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.

    • setAttachmentType

      @Stability(Stable) public void setAttachmentType(@NotNull String value)
      The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.

    • getDomainCertificateArn

      @Stability(Stable) @NotNull public String getDomainCertificateArn()
      The ARN of a public TLS/SSL certificate imported into or created with ACM.

    • setDomainCertificateArn

      @Stability(Stable) public void setDomainCertificateArn(@NotNull String value)
      The ARN of a public TLS/SSL certificate imported into or created with ACM.

    • getEndpointDomainPrefix

      @Stability(Stable) @NotNull public String getEndpointDomainPrefix()
      A custom identifier that is prepended to the DNS name that is generated for the endpoint.

    • setEndpointDomainPrefix

      @Stability(Stable) public void setEndpointDomainPrefix(@NotNull String value)
      A custom identifier that is prepended to the DNS name that is generated for the endpoint.

    • getEndpointType

      @Stability(Stable) @NotNull public String getEndpointType()
      The type of AWS Verified Access endpoint.

      Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.

    • setEndpointType

      @Stability(Stable) public void setEndpointType(@NotNull String value)
      The type of AWS Verified Access endpoint.

      Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.

    • getVerifiedAccessGroupId

      @Stability(Stable) @NotNull public String getVerifiedAccessGroupId()
      The ID of the AWS Verified Access group.

    • setVerifiedAccessGroupId

      @Stability(Stable) public void setVerifiedAccessGroupId(@NotNull String value)
      The ID of the AWS Verified Access group.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the AWS Verified Access endpoint.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the AWS Verified Access endpoint.

    • getLoadBalancerOptions

      @Stability(Stable) @Nullable public Object getLoadBalancerOptions()
      The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.

    • setLoadBalancerOptions

      @Stability(Stable) public void setLoadBalancerOptions(@Nullable IResolvable value)
      The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.

    • setLoadBalancerOptions

      @Stability(Stable) public void setLoadBalancerOptions(@Nullable CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty value)
      The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.

    • getNetworkInterfaceOptions

      @Stability(Stable) @Nullable public Object getNetworkInterfaceOptions()
      The options for network-interface type endpoint.

    • setNetworkInterfaceOptions

      @Stability(Stable) public void setNetworkInterfaceOptions(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public String getPolicyDocument()
      The Verified Access policy document.

    • setPolicyDocument

      @Stability(Stable) public void setPolicyDocument(@Nullable String value)
      The Verified Access policy document.

    • getPolicyEnabled

      @Stability(Stable) @Nullable public Object getPolicyEnabled()
      The status of the Verified Access policy.

    • setPolicyEnabled

      @Stability(Stable) public void setPolicyEnabled(@Nullable Boolean value)
      The status of the Verified Access policy.

    • setPolicyEnabled

      @Stability(Stable) public void setPolicyEnabled(@Nullable IResolvable value)
      The status of the Verified Access policy.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      The IDs of the security groups for the endpoint.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      The IDs of the security groups for the endpoint.