CfnVpcAttachment
- class aws_cdk.aws_networkmanager.CfnVpcAttachment(scope, id, *, core_network_id, subnet_arns, vpc_arn, options=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::NetworkManager::VpcAttachment
.Creates a VPC attachment on an edge location of a core network.
- CloudformationResource
AWS::NetworkManager::VpcAttachment
- 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_networkmanager as networkmanager cfn_vpc_attachment = networkmanager.CfnVpcAttachment(self, "MyCfnVpcAttachment", core_network_id="coreNetworkId", subnet_arns=["subnetArns"], vpc_arn="vpcArn", # the properties below are optional options=networkmanager.CfnVpcAttachment.VpcOptionsProperty( appliance_mode_support=False, ipv6_support=False ), tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::NetworkManager::VpcAttachment
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
core_network_id (
str
) – The core network ID.subnet_arns (
Sequence
[str
]) – The subnet ARNs.vpc_arn (
str
) – The ARN of the VPC attachment.options (
Union
[IResolvable
,VpcOptionsProperty
,Dict
[str
,Any
],None
]) – Options for creating the VPC attachment.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags associated with the VPC attachment.
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
addPropertyOverride
or prefixpath
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 toaddOverride
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 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::NetworkManager::VpcAttachment'
- attr_attachment_id
The ID of the VPC attachment.
- CloudformationAttribute
AttachmentId
- attr_attachment_policy_rule_number
The policy rule number associated with the attachment.
- CloudformationAttribute
AttachmentPolicyRuleNumber
- attr_attachment_type
The type of attachment.
This will be
VPC
.- CloudformationAttribute
AttachmentType
- attr_core_network_arn
The ARN of the core network.
- CloudformationAttribute
CoreNetworkArn
- attr_created_at
The timestamp when the VPC attachment was created.
- CloudformationAttribute
CreatedAt
- attr_edge_location
The Region where the core network edge is located.
- CloudformationAttribute
EdgeLocation
- attr_owner_account_id
The ID of the VPC attachment owner.
- CloudformationAttribute
OwnerAccountId
- attr_proposed_segment_change_attachment_policy_rule_number
ProposedSegmentChange.AttachmentPolicyRuleNumber
- Type
cloudformationAttribute
- attr_proposed_segment_change_segment_name
ProposedSegmentChange.SegmentName
- Type
cloudformationAttribute
- attr_proposed_segment_change_tags
ProposedSegmentChange.Tags
- Type
cloudformationAttribute
- attr_resource_arn
The resource ARN for the VPC attachment.
- CloudformationAttribute
ResourceArn
- attr_segment_name
The name of the attachment’s segment.
- CloudformationAttribute
SegmentName
- attr_state
The state of the attachment.
This can be:
REJECTED
|PENDING_ATTACHMENT_ACCEPTANCE
|CREATING
|FAILED
|AVAILABLE
|UPDATING
|PENDING_NETWORK_UPDATE
|PENDING_TAG_ACCEPTANCE
|DELETING
.- CloudformationAttribute
State
- attr_updated_at
The timestamp when the VPC attachment was last updated.
- CloudformationAttribute
UpdatedAt
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- core_network_id
The core network ID.
- 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.
- 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 construct tree node associated with this construct.
- options
Options for creating the VPC attachment.
- 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).
- subnet_arns
The subnet ARNs.
- tags
The tags associated with the VPC attachment.
- vpc_arn
The ARN of the VPC attachment.
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(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
ProposedSegmentChangeProperty
- class CfnVpcAttachment.ProposedSegmentChangeProperty(*, attachment_policy_rule_number=None, segment_name=None, tags=None)
Bases:
object
Describes a proposed segment change.
In some cases, the segment change must first be evaluated and accepted.
- Parameters
attachment_policy_rule_number (
Union
[int
,float
,None
]) – The rule number in the policy document that applies to this change.segment_name (
Optional
[str
]) – The name of the segment to change.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The list of key-value tags that changed for the segment.
- 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_networkmanager as networkmanager proposed_segment_change_property = networkmanager.CfnVpcAttachment.ProposedSegmentChangeProperty( attachment_policy_rule_number=123, segment_name="segmentName", tags=[CfnTag( key="key", value="value" )] )
Attributes
- attachment_policy_rule_number
The rule number in the policy document that applies to this change.
- segment_name
The name of the segment to change.
- tags
The list of key-value tags that changed for the segment.
VpcOptionsProperty
- class CfnVpcAttachment.VpcOptionsProperty(*, appliance_mode_support=None, ipv6_support=None)
Bases:
object
Describes the VPC options.
- Parameters
appliance_mode_support (
Union
[bool
,IResolvable
,None
]) – Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value isfalse
.ipv6_support (
Union
[bool
,IResolvable
,None
]) – Indicates whether IPv6 is supported.
- 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_networkmanager as networkmanager vpc_options_property = networkmanager.CfnVpcAttachment.VpcOptionsProperty( appliance_mode_support=False, ipv6_support=False )
Attributes
- appliance_mode_support
Indicates whether appliance mode is supported.
If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is
false
.
- ipv6_support
Indicates whether IPv6 is supported.