CfnVerifiedAccessEndpoint
- class aws_cdk.aws_ec2.CfnVerifiedAccessEndpoint(scope, id, *, application_domain, attachment_type, domain_certificate_arn, endpoint_domain_prefix, endpoint_type, verified_access_group_id, description=None, load_balancer_options=None, network_interface_options=None, policy_document=None, policy_enabled=None, security_group_ids=None, tags=None)
Bases:
CfnResourceA 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.
- CloudformationResource:
AWS::EC2::VerifiedAccessEndpoint
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 cfn_verified_access_endpoint = ec2.CfnVerifiedAccessEndpoint(self, "MyCfnVerifiedAccessEndpoint", application_domain="applicationDomain", attachment_type="attachmentType", domain_certificate_arn="domainCertificateArn", endpoint_domain_prefix="endpointDomainPrefix", endpoint_type="endpointType", verified_access_group_id="verifiedAccessGroupId", # the properties below are optional description="description", load_balancer_options=ec2.CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty( load_balancer_arn="loadBalancerArn", port=123, protocol="protocol", subnet_ids=["subnetIds"] ), network_interface_options=ec2.CfnVerifiedAccessEndpoint.NetworkInterfaceOptionsProperty( network_interface_id="networkInterfaceId", port=123, protocol="protocol" ), policy_document="policyDocument", policy_enabled=False, security_group_ids=["securityGroupIds"], tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::EC2::VerifiedAccessEndpoint.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
application_domain (
str) – The DNS name for users to reach your application.attachment_type (
str) – The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.domain_certificate_arn (
str) – The ARN of a public TLS/SSL certificate imported into or created with ACM.endpoint_domain_prefix (
str) – A custom identifier that is prepended to the DNS name that is generated for the endpoint.endpoint_type (
str) – 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.verified_access_group_id (
str) – The ID of the AWS Verified Access group.description (
Optional[str]) – A description for the AWS Verified Access endpoint.load_balancer_options (
Union[IResolvable,LoadBalancerOptionsProperty,Dict[str,Any],None]) – The load balancer details if creating the AWS Verified Access endpoint asload-balancertype.network_interface_options (
Union[IResolvable,NetworkInterfaceOptionsProperty,Dict[str,Any],None]) – The options for network-interface type endpoint.policy_document (
Optional[str]) – The Verified Access policy document.policy_enabled (
Union[bool,IResolvable,None]) – The status of the Verified Access policy.security_group_ids (
Optional[Sequence[str]]) – The IDs of the security groups for the endpoint.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The tags.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::EC2::VerifiedAccessEndpoint'
- application_domain
The DNS name for users to reach your application.
- attachment_type
The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
- attr_creation_time
The creation time.
- CloudformationAttribute:
CreationTime
- attr_device_validation_domain
Use this to construct the redirect URI to add to your OIDC provider’s allow list.
- CloudformationAttribute:
DeviceValidationDomain
- attr_endpoint_domain
The DNS name generated for the endpoint.
- CloudformationAttribute:
EndpointDomain
- attr_last_updated_time
The last updated time.
- CloudformationAttribute:
LastUpdatedTime
- attr_status
The endpoint status.
- CloudformationAttribute:
Status
- attr_verified_access_endpoint_id
The ID of the Verified Access endpoint.
- CloudformationAttribute:
VerifiedAccessEndpointId
- attr_verified_access_instance_id
The instance identifier.
- CloudformationAttribute:
VerifiedAccessInstanceId
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
A description for the AWS Verified Access endpoint.
- domain_certificate_arn
The ARN of a public TLS/SSL certificate imported into or created with ACM.
- endpoint_domain_prefix
A custom identifier that is prepended to the DNS name that is generated for the endpoint.
- endpoint_type
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.
- load_balancer_options
The load balancer details if creating the AWS Verified Access endpoint as
load-balancertype.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- network_interface_options
The options for network-interface type endpoint.
- node
The construct tree node associated with this construct.
- policy_document
The Verified Access policy document.
- policy_enabled
The status of the Verified Access policy.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- security_group_ids
The IDs of the security groups for the endpoint.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
The tags.
- verified_access_group_id
The ID of the AWS Verified Access group.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool
LoadBalancerOptionsProperty
- class CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty(*, load_balancer_arn=None, port=None, protocol=None, subnet_ids=None)
Bases:
objectDescribes the load balancer options when creating an AWS Verified Access endpoint using the
load-balancertype.- Parameters:
load_balancer_arn (
Optional[str]) – The ARN of the load balancer.port (
Union[int,float,None]) – The IP port number.protocol (
Optional[str]) – The IP protocol.subnet_ids (
Optional[Sequence[str]]) – The IDs of the subnets.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 load_balancer_options_property = ec2.CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty( load_balancer_arn="loadBalancerArn", port=123, protocol="protocol", subnet_ids=["subnetIds"] )
Attributes
- load_balancer_arn
The ARN of the load balancer.
- port
The IP port number.
- protocol
The IP protocol.
NetworkInterfaceOptionsProperty
- class CfnVerifiedAccessEndpoint.NetworkInterfaceOptionsProperty(*, network_interface_id=None, port=None, protocol=None)
Bases:
objectDescribes the network interface options when creating an AWS Verified Access endpoint using the
network-interfacetype.- Parameters:
network_interface_id (
Optional[str]) – The ID of the network interface.port (
Union[int,float,None]) – The IP port number.protocol (
Optional[str]) – The IP protocol.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 network_interface_options_property = ec2.CfnVerifiedAccessEndpoint.NetworkInterfaceOptionsProperty( network_interface_id="networkInterfaceId", port=123, protocol="protocol" )
Attributes
- network_interface_id
The ID of the network interface.
- port
The IP port number.