CfnCrossAccountAttachmentPropsMixin

class aws_cdk.mixins_preview.aws_globalaccelerator.mixins.CfnCrossAccountAttachmentPropsMixin(props, *, strategy=None)

Bases: Mixin

Create a cross-account attachment in AWS Global Accelerator .

You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared.

A principal can be an AWS account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment.

Specify each principal and resource separately. To specify two CIDR address pools, list them individually under Resources , and so on. For a command line operation, for example, you might use a statement like the following:

"Resources": [{"Cidr": "169.254.60.0/24"},{"Cidr": "169.254.59.0/24"}]

For more information, see Working with cross-account attachments and resources in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-crossaccountattachment.html
CloudformationResource:: AWS::GlobalAccelerator::CrossAccountAttachment
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_globalaccelerator import mixins as globalaccelerator_mixins

cfn_cross_account_attachment_props_mixin = globalaccelerator_mixins.CfnCrossAccountAttachmentPropsMixin(globalaccelerator_mixins.CfnCrossAccountAttachmentMixinProps(
    name="name",
    principals=["principals"],
    resources=[globalaccelerator_mixins.CfnCrossAccountAttachmentPropsMixin.ResourceProperty(
        cidr="cidr",
        endpoint_id="endpointId",
        region="region"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::GlobalAccelerator::CrossAccountAttachment.

Parameters:

props (Union[CfnCrossAccountAttachmentMixinProps, 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 = ['name', 'principals', 'resources', 'tags']

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

ResourceProperty

class CfnCrossAccountAttachmentPropsMixin.ResourceProperty(*, cidr=None, endpoint_id=None, region=None)

Bases: object

A resource is one of the following: the ARN for an AWS resource that is supported by AWS Global Accelerator to be added as an endpoint, or a CIDR range that specifies a bring your own IP (BYOIP) address pool.

Parameters:

cidr (Optional[str]) – An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in AWS Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
endpoint_id (Optional[str]) – The endpoint ID for the endpoint that is specified as a AWS resource. An endpoint ID for the cross-account feature is the ARN of an AWS resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.
region (Optional[str]) – The AWS Region where a shared endpoint resource is located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-crossaccountattachment-resource.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_globalaccelerator import mixins as globalaccelerator_mixins

resource_property = globalaccelerator_mixins.CfnCrossAccountAttachmentPropsMixin.ResourceProperty(
    cidr="cidr",
    endpoint_id="endpointId",
    region="region"
)

Attributes

cidr

An IP address range, in CIDR format, that is specified as resource.

The address must be provisioned and advertised in AWS Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator

For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-crossaccountattachment-resource.html#cfn-globalaccelerator-crossaccountattachment-resource-cidr

endpoint_id

The endpoint ID for the endpoint that is specified as a AWS resource.

An endpoint ID for the cross-account feature is the ARN of an AWS resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-crossaccountattachment-resource.html#cfn-globalaccelerator-crossaccountattachment-resource-endpointid

region

The AWS Region where a shared endpoint resource is located.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-crossaccountattachment-resource.html#cfn-globalaccelerator-crossaccountattachment-resource-region