CfnSiteProps

class aws_cdk.aws_networkmanager.CfnSiteProps(*, global_network_id, description=None, location=None, tags=None)

Bases: object

Properties for defining a CfnSite.

Parameters:
  • global_network_id (str) – The ID of the global network.

  • description (Optional[str]) – A description of your site. Constraints: Maximum length of 256 characters.

  • location (Union[IResolvable, LocationProperty, Dict[str, Any], None]) – The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated. - Address : The physical address of the site. - Latitude : The latitude of the site. - Longitude : The longitude of the site.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags for the site.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.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_networkmanager as networkmanager

cfn_site_props = networkmanager.CfnSiteProps(
    global_network_id="globalNetworkId",

    # the properties below are optional
    description="description",
    location=networkmanager.CfnSite.LocationProperty(
        address="address",
        latitude="latitude",
        longitude="longitude"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description of your site.

Constraints: Maximum length of 256 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#cfn-networkmanager-site-description

global_network_id

The ID of the global network.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#cfn-networkmanager-site-globalnetworkid

location

The site location.

This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

  • Address : The physical address of the site.

  • Latitude : The latitude of the site.

  • Longitude : The longitude of the site.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#cfn-networkmanager-site-location

tags

The tags for the site.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#cfn-networkmanager-site-tags