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 {
ApplicationDomain = "applicationDomain",
AttachmentType = "attachmentType",
DomainCertificateArn = "domainCertificateArn",
EndpointDomainPrefix = "endpointDomainPrefix",
EndpointType = "endpointType",
VerifiedAccessGroupId = "verifiedAccessGroupId",
// the properties below are optional
Description = "description",
LoadBalancerOptions = new LoadBalancerOptionsProperty {
LoadBalancerArn = "loadBalancerArn",
Port = 123,
Protocol = "protocol",
SubnetIds = new [] { "subnetIds" }
},
NetworkInterfaceOptions = new NetworkInterfaceOptionsProperty {
NetworkInterfaceId = "networkInterfaceId",
Port = 123,
Protocol = "protocol"
},
PolicyDocument = "policyDocument",
PolicyEnabled = false,
SecurityGroupIds = new [] { "securityGroupIds" },
SseSpecification = new SseSpecificationProperty {
CustomerManagedKeyEnabled = false,
KmsKeyArn = "kmsKeyArn"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnVerifiedAccessEndpoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnVerifiedAccessEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnVerifiedAccessEndpoint(Construct, String, ICfnVerifiedAccessEndpointProps) |
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 | |
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. |
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>) |
Constructors
CfnVerifiedAccessEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnVerifiedAccessEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnVerifiedAccessEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnVerifiedAccessEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnVerifiedAccessEndpoint(Construct, String, ICfnVerifiedAccessEndpointProps)
public CfnVerifiedAccessEndpoint(Construct scope, string id, ICfnVerifiedAccessEndpointProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnVerifiedAccessEndpointProps
Resource properties.
Properties
ApplicationDomain
The DNS name for users to reach your application.
public virtual string ApplicationDomain { get; set; }
Property Value
System.String
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
System.String
AttrCreationTime
The creation time.
public virtual string AttrCreationTime { get; }
Property Value
System.String
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
System.String
Remarks
CloudformationAttribute: DeviceValidationDomain
AttrEndpointDomain
The DNS name generated for the endpoint.
public virtual string AttrEndpointDomain { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EndpointDomain
AttrLastUpdatedTime
The last updated time.
public virtual string AttrLastUpdatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdatedTime
AttrStatus
The endpoint status.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
AttrVerifiedAccessEndpointId
The ID of the Verified Access endpoint.
public virtual string AttrVerifiedAccessEndpointId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: VerifiedAccessEndpointId
AttrVerifiedAccessInstanceId
The instance identifier.
public virtual string AttrVerifiedAccessInstanceId { get; }
Property Value
System.String
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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description for the AWS Verified Access endpoint.
public virtual string Description { get; set; }
Property Value
System.String
DomainCertificateArn
The ARN of a public TLS/SSL certificate imported into or created with ACM.
public virtual string DomainCertificateArn { get; set; }
Property Value
System.String
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
System.String
EndpointType
The type of AWS Verified Access endpoint.
public virtual string EndpointType { get; set; }
Property Value
System.String
LoadBalancerOptions
The load balancer details if creating the AWS Verified Access endpoint as load-balancer
type.
public virtual object LoadBalancerOptions { get; set; }
Property Value
System.Object
NetworkInterfaceOptions
The options for network-interface type endpoint.
public virtual object NetworkInterfaceOptions { get; set; }
Property Value
System.Object
PolicyDocument
The Verified Access policy document.
public virtual string PolicyDocument { get; set; }
Property Value
System.String
PolicyEnabled
The status of the Verified Access policy.
public virtual object PolicyEnabled { get; set; }
Property Value
System.Object
SecurityGroupIds
The IDs of the security groups for the endpoint.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
SseSpecification
The options for additional server side encryption.
public virtual object SseSpecification { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
VerifiedAccessGroupId
The ID of the AWS Verified Access group.
public virtual string VerifiedAccessGroupId { get; set; }
Property Value
System.String
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>