CfnVerifiedAccessInstance

class aws_cdk.aws_ec2.CfnVerifiedAccessInstance(scope, id, *, description=None, fips_enabled=None, logging_configurations=None, tags=None, verified_access_trust_provider_ids=None, verified_access_trust_providers=None)

Bases: CfnResource

An AWS Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html
CloudformationResource:: AWS::EC2::VerifiedAccessInstance
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cfn_verified_access_instance = ec2.CfnVerifiedAccessInstance(self, "MyCfnVerifiedAccessInstance",
    description="description",
    fips_enabled=False,
    logging_configurations=ec2.CfnVerifiedAccessInstance.VerifiedAccessLogsProperty(
        cloud_watch_logs=ec2.CfnVerifiedAccessInstance.CloudWatchLogsProperty(
            enabled=False,
            log_group="logGroup"
        ),
        include_trust_context=False,
        kinesis_data_firehose=ec2.CfnVerifiedAccessInstance.KinesisDataFirehoseProperty(
            delivery_stream="deliveryStream",
            enabled=False
        ),
        log_version="logVersion",
        s3=ec2.CfnVerifiedAccessInstance.S3Property(
            bucket_name="bucketName",
            bucket_owner="bucketOwner",
            enabled=False,
            prefix="prefix"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    verified_access_trust_provider_ids=["verifiedAccessTrustProviderIds"],
    verified_access_trust_providers=[ec2.CfnVerifiedAccessInstance.VerifiedAccessTrustProviderProperty(
        description="description",
        device_trust_provider_type="deviceTrustProviderType",
        trust_provider_type="trustProviderType",
        user_trust_provider_type="userTrustProviderType",
        verified_access_trust_provider_id="verifiedAccessTrustProviderId"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
description (Optional[str]) – A description for the AWS Verified Access instance.
fips_enabled (Union[bool, IResolvable, None]) – Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.
logging_configurations (Union[IResolvable, VerifiedAccessLogsProperty, Dict[str, Any], None]) – The logging configuration for the Verified Access instances.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags.
verified_access_trust_provider_ids (Optional[Sequence[str]]) – The IDs of the AWS Verified Access trust providers.
verified_access_trust_providers (Union[IResolvable, Sequence[Union[IResolvable, VerifiedAccessTrustProviderProperty, Dict[str, Any]]], None]) – The IDs of the AWS Verified Access trust providers.

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_dependency(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_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

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 addPropertyOverride or prefix path with “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 value argument to addOverride will 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 intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

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

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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::VerifiedAccessInstance'

attr_creation_time

The creation time.

CloudformationAttribute:: CreationTime

attr_last_updated_time

The last updated time.

CloudformationAttribute:: LastUpdatedTime

attr_verified_access_instance_id

The ID of the Verified Access instance.

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 instance.

fips_enabled: Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.

logging_configurations: The logging configuration for the Verified Access instances.

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.

node: The tree node.

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 }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: The tags.

verified_access_trust_provider_ids: The IDs of the AWS Verified Access trust providers.

verified_access_trust_providers: The IDs of the AWS Verified Access trust providers.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to 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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

CloudWatchLogsProperty

class CfnVerifiedAccessInstance.CloudWatchLogsProperty(*, enabled=None, log_group=None)

Bases: object

Options for CloudWatch Logs as a logging destination.

Parameters:

enabled (Union[bool, IResolvable, None]) – Indicates whether logging is enabled.
log_group (Optional[str]) – The ID of the CloudWatch Logs log group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cloud_watch_logs_property = ec2.CfnVerifiedAccessInstance.CloudWatchLogsProperty(
    enabled=False,
    log_group="logGroup"
)

Attributes

enabled

Indicates whether logging is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html#cfn-ec2-verifiedaccessinstance-cloudwatchlogs-enabled

log_group

The ID of the CloudWatch Logs log group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html#cfn-ec2-verifiedaccessinstance-cloudwatchlogs-loggroup

KinesisDataFirehoseProperty

class CfnVerifiedAccessInstance.KinesisDataFirehoseProperty(*, delivery_stream=None, enabled=None)

Bases: object

Options for Kinesis as a logging destination.

Parameters:

delivery_stream (Optional[str]) – The ID of the delivery stream.
enabled (Union[bool, IResolvable, None]) – Indicates whether logging is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

kinesis_data_firehose_property = ec2.CfnVerifiedAccessInstance.KinesisDataFirehoseProperty(
    delivery_stream="deliveryStream",
    enabled=False
)

Attributes

delivery_stream

The ID of the delivery stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html#cfn-ec2-verifiedaccessinstance-kinesisdatafirehose-deliverystream

enabled

Indicates whether logging is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html#cfn-ec2-verifiedaccessinstance-kinesisdatafirehose-enabled

S3Property

class CfnVerifiedAccessInstance.S3Property(*, bucket_name=None, bucket_owner=None, enabled=None, prefix=None)

Bases: object

Options for Amazon S3 as a logging destination.

Parameters:

bucket_name (Optional[str]) – The bucket name.
bucket_owner (Optional[str]) – The AWS account number that owns the bucket.
enabled (Union[bool, IResolvable, None]) – Indicates whether logging is enabled.
prefix (Optional[str]) – The bucket prefix.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

s3_property = ec2.CfnVerifiedAccessInstance.S3Property(
    bucket_name="bucketName",
    bucket_owner="bucketOwner",
    enabled=False,
    prefix="prefix"
)

Attributes

bucket_name

The bucket name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-bucketname

bucket_owner

The AWS account number that owns the bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-bucketowner

enabled

Indicates whether logging is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-enabled

prefix

The bucket prefix.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-prefix

VerifiedAccessLogsProperty

class CfnVerifiedAccessInstance.VerifiedAccessLogsProperty(*, cloud_watch_logs=None, include_trust_context=None, kinesis_data_firehose=None, log_version=None, s3=None)

Bases: object

Describes the options for Verified Access logs.

Parameters:

cloud_watch_logs (Union[IResolvable, CloudWatchLogsProperty, Dict[str, Any], None]) – CloudWatch Logs logging destination.
include_trust_context (Union[bool, IResolvable, None]) – Indicates whether to include trust data sent by trust providers in the logs.
kinesis_data_firehose (Union[IResolvable, KinesisDataFirehoseProperty, Dict[str, Any], None]) – Kinesis logging destination.
log_version (Optional[str]) – The logging version. Valid values: ocsf-0.1 | ocsf-1.0.0-rc.2
s3 (Union[IResolvable, S3Property, Dict[str, Any], None]) – Amazon S3 logging options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

verified_access_logs_property = ec2.CfnVerifiedAccessInstance.VerifiedAccessLogsProperty(
    cloud_watch_logs=ec2.CfnVerifiedAccessInstance.CloudWatchLogsProperty(
        enabled=False,
        log_group="logGroup"
    ),
    include_trust_context=False,
    kinesis_data_firehose=ec2.CfnVerifiedAccessInstance.KinesisDataFirehoseProperty(
        delivery_stream="deliveryStream",
        enabled=False
    ),
    log_version="logVersion",
    s3=ec2.CfnVerifiedAccessInstance.S3Property(
        bucket_name="bucketName",
        bucket_owner="bucketOwner",
        enabled=False,
        prefix="prefix"
    )
)

Attributes

cloud_watch_logs

CloudWatch Logs logging destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-cloudwatchlogs

include_trust_context

Indicates whether to include trust data sent by trust providers in the logs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-includetrustcontext

kinesis_data_firehose

Kinesis logging destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-kinesisdatafirehose

log_version

The logging version.

Valid values: ocsf-0.1 | ocsf-1.0.0-rc.2

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-logversion

s3

Amazon S3 logging options.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-s3

VerifiedAccessTrustProviderProperty

class CfnVerifiedAccessInstance.VerifiedAccessTrustProviderProperty(*, description=None, device_trust_provider_type=None, trust_provider_type=None, user_trust_provider_type=None, verified_access_trust_provider_id=None)

Bases: object

A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices.

When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.

Parameters:

description (Optional[str]) – A description for the AWS Verified Access trust provider.
device_trust_provider_type (Optional[str]) – The type of device-based trust provider.
trust_provider_type (Optional[str]) – The type of Verified Access trust provider.
user_trust_provider_type (Optional[str]) – The type of user-based trust provider.
verified_access_trust_provider_id (Optional[str]) – The ID of the AWS Verified Access trust provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

verified_access_trust_provider_property = ec2.CfnVerifiedAccessInstance.VerifiedAccessTrustProviderProperty(
    description="description",
    device_trust_provider_type="deviceTrustProviderType",
    trust_provider_type="trustProviderType",
    user_trust_provider_type="userTrustProviderType",
    verified_access_trust_provider_id="verifiedAccessTrustProviderId"
)