CfnEndpointPropsMixin

class aws_cdk.mixins_preview.aws_s3outposts.mixins.CfnEndpointPropsMixin(props, *, strategy=None)

Bases: Mixin

This AWS::S3Outposts::Endpoint resource specifies an endpoint and associates it with the specified Outpost.

Amazon S3 on Outposts access points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to S3 on Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC-only access points . .. epigraph:

It can take up to 5 minutes for this resource to be created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html
CloudformationResource:: AWS::S3Outposts::Endpoint
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_s3outposts import mixins as s3outposts_mixins

cfn_endpoint_props_mixin = s3outposts_mixins.CfnEndpointPropsMixin(s3outposts_mixins.CfnEndpointMixinProps(
    access_type="accessType",
    customer_owned_ipv4_pool="customerOwnedIpv4Pool",
    failed_reason=s3outposts_mixins.CfnEndpointPropsMixin.FailedReasonProperty(
        error_code="errorCode",
        message="message"
    ),
    outpost_id="outpostId",
    security_group_id="securityGroupId",
    subnet_id="subnetId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::S3Outposts::Endpoint.

Parameters:

props (Union[CfnEndpointMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessType', 'customerOwnedIpv4Pool', 'failedReason', 'outpostId', 'securityGroupId', 'subnetId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

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

FailedReasonProperty

class CfnEndpointPropsMixin.FailedReasonProperty(*, error_code=None, message=None)

Bases: object

The failure reason, if any, for a create or delete endpoint operation.

Parameters:

error_code (Optional[str]) – The failure code, if any, for a create or delete endpoint operation.
message (Optional[str]) – Additional error details describing the endpoint failure and recommended action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-failedreason.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.mixins_preview.aws_s3outposts import mixins as s3outposts_mixins

failed_reason_property = s3outposts_mixins.CfnEndpointPropsMixin.FailedReasonProperty(
    error_code="errorCode",
    message="message"
)

Attributes

error_code

The failure code, if any, for a create or delete endpoint operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-failedreason.html#cfn-s3outposts-endpoint-failedreason-errorcode

message

Additional error details describing the endpoint failure and recommended action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-failedreason.html#cfn-s3outposts-endpoint-failedreason-message

NetworkInterfaceProperty

class CfnEndpointPropsMixin.NetworkInterfaceProperty(*, network_interface_id=None)

Bases: object

The container for the network interface.

Parameters:: network_interface_id (Optional[str]) – The ID for the network interface.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-networkinterface.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.mixins_preview.aws_s3outposts import mixins as s3outposts_mixins

network_interface_property = s3outposts_mixins.CfnEndpointPropsMixin.NetworkInterfaceProperty(
    network_interface_id="networkInterfaceId"
)

Attributes

network_interface_id

The ID for the network interface.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-networkinterface.html#cfn-s3outposts-endpoint-networkinterface-networkinterfaceid