Class CfnVerifiedAccessEndpoint
An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnVerifiedAccessEndpoint : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnVerifiedAccessEndpoint Inherits CfnResource Implements IInspectable, ITaggable
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var cfnVerifiedAccessEndpoint = new CfnVerifiedAccessEndpoint(this, "MyCfnVerifiedAccessEndpoint", new CfnVerifiedAccessEndpointProps {
AttachmentType = "attachmentType",
EndpointType = "endpointType",
VerifiedAccessGroupId = "verifiedAccessGroupId",
// the properties below are optional
ApplicationDomain = "applicationDomain",
CidrOptions = new CidrOptionsProperty {
Cidr = "cidr",
PortRanges = new [] { new PortRangeProperty {
FromPort = 123,
ToPort = 123
} },
Protocol = "protocol",
SubnetIds = new [] { "subnetIds" }
},
Description = "description",
DomainCertificateArn = "domainCertificateArn",
EndpointDomainPrefix = "endpointDomainPrefix",
LoadBalancerOptions = new LoadBalancerOptionsProperty {
LoadBalancerArn = "loadBalancerArn",
Port = 123,
PortRanges = new [] { new PortRangeProperty {
FromPort = 123,
ToPort = 123
} },
Protocol = "protocol",
SubnetIds = new [] { "subnetIds" }
},
NetworkInterfaceOptions = new NetworkInterfaceOptionsProperty {
NetworkInterfaceId = "networkInterfaceId",
Port = 123,
PortRanges = new [] { new PortRangeProperty {
FromPort = 123,
ToPort = 123
} },
Protocol = "protocol"
},
PolicyDocument = "policyDocument",
PolicyEnabled = false,
RdsOptions = new RdsOptionsProperty {
Port = 123,
Protocol = "protocol",
RdsDbClusterArn = "rdsDbClusterArn",
RdsDbInstanceArn = "rdsDbInstanceArn",
RdsDbProxyArn = "rdsDbProxyArn",
RdsEndpoint = "rdsEndpoint",
SubnetIds = new [] { "subnetIds" }
},
SecurityGroupIds = new [] { "securityGroupIds" },
SseSpecification = new SseSpecificationProperty {
CustomerManagedKeyEnabled = false,
KmsKeyArn = "kmsKeyArn"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnVerifiedAccessEndpoint(Construct, string, ICfnVerifiedAccessEndpointProps) | An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to. |
Properties
ApplicationDomain | The DNS name for users to reach your application. |
AttachmentType | The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application. |
AttrCreationTime | The creation time. |
AttrDeviceValidationDomain | Use this to construct the redirect URI to add to your OIDC provider's allow list. |
AttrEndpointDomain | The DNS name generated for the endpoint. |
AttrLastUpdatedTime | The last updated time. |
AttrStatus | The endpoint status. |
AttrVerifiedAccessEndpointId | The ID of the Verified Access endpoint. |
AttrVerifiedAccessInstanceId | The instance identifier. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to. |
CidrOptions | The options for a CIDR endpoint. |
Description | A description for the AWS Verified Access endpoint. |
DomainCertificateArn | The ARN of a public TLS/SSL certificate imported into or created with ACM. |
EndpointDomainPrefix | A custom identifier that is prepended to the DNS name that is generated for the endpoint. |
EndpointType | The type of AWS Verified Access endpoint. |
LoadBalancerOptions | The load balancer details if creating the AWS Verified Access endpoint as |
NetworkInterfaceOptions | The options for network-interface type endpoint. |
PolicyDocument | The Verified Access policy document. |
PolicyEnabled | The status of the Verified Access policy. |
RdsOptions | The options for an RDS endpoint. |
SecurityGroupIds | The IDs of the security groups for the endpoint. |
SseSpecification | The options for additional server side encryption. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags. |
VerifiedAccessGroupId | The ID of the AWS Verified Access group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<string, object>) | An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to. |
Constructors
CfnVerifiedAccessEndpoint(Construct, string, ICfnVerifiedAccessEndpointProps)
An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to.
public CfnVerifiedAccessEndpoint(Construct scope, string id, ICfnVerifiedAccessEndpointProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnVerifiedAccessEndpointProps
Resource properties.
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
Properties
ApplicationDomain
The DNS name for users to reach your application.
public virtual string? ApplicationDomain { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
AttachmentType
The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
public virtual string AttachmentType { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
AttrCreationTime
The creation time.
public virtual string AttrCreationTime { get; }
Property Value
Remarks
CloudformationAttribute: CreationTime
AttrDeviceValidationDomain
Use this to construct the redirect URI to add to your OIDC provider's allow list.
public virtual string AttrDeviceValidationDomain { get; }
Property Value
Remarks
CloudformationAttribute: DeviceValidationDomain
AttrEndpointDomain
The DNS name generated for the endpoint.
public virtual string AttrEndpointDomain { get; }
Property Value
Remarks
CloudformationAttribute: EndpointDomain
AttrLastUpdatedTime
The last updated time.
public virtual string AttrLastUpdatedTime { get; }
Property Value
Remarks
CloudformationAttribute: LastUpdatedTime
AttrStatus
The endpoint status.
public virtual string AttrStatus { get; }
Property Value
Remarks
CloudformationAttribute: Status
AttrVerifiedAccessEndpointId
The ID of the Verified Access endpoint.
public virtual string AttrVerifiedAccessEndpointId { get; }
Property Value
Remarks
CloudformationAttribute: VerifiedAccessEndpointId
AttrVerifiedAccessInstanceId
The instance identifier.
public virtual string AttrVerifiedAccessInstanceId { get; }
Property Value
Remarks
CloudformationAttribute: VerifiedAccessInstanceId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
CfnProperties
An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
CidrOptions
The options for a CIDR endpoint.
public virtual object? CidrOptions { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
Description
A description for the AWS Verified Access endpoint.
public virtual string? Description { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
DomainCertificateArn
The ARN of a public TLS/SSL certificate imported into or created with ACM.
public virtual string? DomainCertificateArn { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
EndpointDomainPrefix
A custom identifier that is prepended to the DNS name that is generated for the endpoint.
public virtual string? EndpointDomainPrefix { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
EndpointType
The type of AWS Verified Access endpoint.
public virtual string EndpointType { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
LoadBalancerOptions
The load balancer details if creating the AWS Verified Access endpoint as load-balancer
type.
public virtual object? LoadBalancerOptions { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
NetworkInterfaceOptions
The options for network-interface type endpoint.
public virtual object? NetworkInterfaceOptions { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
PolicyDocument
The Verified Access policy document.
public virtual string? PolicyDocument { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
PolicyEnabled
The status of the Verified Access policy.
public virtual object? PolicyEnabled { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
RdsOptions
The options for an RDS endpoint.
public virtual object? RdsOptions { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
SecurityGroupIds
The IDs of the security groups for the endpoint.
public virtual string[]? SecurityGroupIds { get; set; }
Property Value
string[]
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
SseSpecification
The options for additional server side encryption.
public virtual object? SseSpecification { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
TagsRaw
The tags.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
VerifiedAccessGroupId
The ID of the AWS Verified Access group.
public virtual string VerifiedAccessGroupId { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
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.
CloudformationResource: AWS::EC2::VerifiedAccessEndpoint
ExampleMetadata: fixture=_generated