Documentation ¶
Index ¶
- func CfnConnectAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConnectAttachment_IsCfnElement(x interface{}) *bool
- func CfnConnectAttachment_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnConnectAttachment_IsConstruct(x interface{}) *bool
- func CfnConnectPeer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConnectPeer_IsCfnElement(x interface{}) *bool
- func CfnConnectPeer_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnConnectPeer_IsConstruct(x interface{}) *bool
- func CfnCoreNetwork_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCoreNetwork_IsCfnElement(x interface{}) *bool
- func CfnCoreNetwork_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCoreNetwork_IsConstruct(x interface{}) *bool
- func CfnCustomerGatewayAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCustomerGatewayAssociation_IsCfnElement(x interface{}) *bool
- func CfnCustomerGatewayAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCustomerGatewayAssociation_IsConstruct(x interface{}) *bool
- func CfnDevice_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDevice_IsCfnElement(x interface{}) *bool
- func CfnDevice_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDevice_IsConstruct(x interface{}) *bool
- func CfnGlobalNetwork_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGlobalNetwork_IsCfnElement(x interface{}) *bool
- func CfnGlobalNetwork_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGlobalNetwork_IsConstruct(x interface{}) *bool
- func CfnLinkAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLinkAssociation_IsCfnElement(x interface{}) *bool
- func CfnLinkAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLinkAssociation_IsConstruct(x interface{}) *bool
- func CfnLink_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLink_IsCfnElement(x interface{}) *bool
- func CfnLink_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLink_IsConstruct(x interface{}) *bool
- func CfnSiteToSiteVpnAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSiteToSiteVpnAttachment_IsCfnElement(x interface{}) *bool
- func CfnSiteToSiteVpnAttachment_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSiteToSiteVpnAttachment_IsConstruct(x interface{}) *bool
- func CfnSite_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSite_IsCfnElement(x interface{}) *bool
- func CfnSite_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSite_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayPeering_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayPeering_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayPeering_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTransitGatewayPeering_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayRegistration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayRegistration_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayRegistration_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTransitGatewayRegistration_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayRouteTableAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayRouteTableAttachment_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayRouteTableAttachment_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTransitGatewayRouteTableAttachment_IsConstruct(x interface{}) *bool
- func CfnVpcAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVpcAttachment_IsCfnElement(x interface{}) *bool
- func CfnVpcAttachment_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnVpcAttachment_IsConstruct(x interface{}) *bool
- func NewCfnConnectAttachment_Override(c CfnConnectAttachment, scope constructs.Construct, id *string, ...)
- func NewCfnConnectPeer_Override(c CfnConnectPeer, scope constructs.Construct, id *string, ...)
- func NewCfnCoreNetwork_Override(c CfnCoreNetwork, scope constructs.Construct, id *string, ...)
- func NewCfnCustomerGatewayAssociation_Override(c CfnCustomerGatewayAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnDevice_Override(c CfnDevice, scope constructs.Construct, id *string, props *CfnDeviceProps)
- func NewCfnGlobalNetwork_Override(c CfnGlobalNetwork, scope constructs.Construct, id *string, ...)
- func NewCfnLinkAssociation_Override(c CfnLinkAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnLink_Override(c CfnLink, scope constructs.Construct, id *string, props *CfnLinkProps)
- func NewCfnSiteToSiteVpnAttachment_Override(c CfnSiteToSiteVpnAttachment, scope constructs.Construct, id *string, ...)
- func NewCfnSite_Override(c CfnSite, scope constructs.Construct, id *string, props *CfnSiteProps)
- func NewCfnTransitGatewayPeering_Override(c CfnTransitGatewayPeering, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGatewayRegistration_Override(c CfnTransitGatewayRegistration, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGatewayRouteTableAttachment_Override(c CfnTransitGatewayRouteTableAttachment, scope constructs.Construct, ...)
- func NewCfnVpcAttachment_Override(c CfnVpcAttachment, scope constructs.Construct, id *string, ...)
- type CfnConnectAttachment
- type CfnConnectAttachmentProps
- type CfnConnectAttachment_ConnectAttachmentOptionsProperty
- type CfnConnectAttachment_ProposedSegmentChangeProperty
- type CfnConnectPeer
- type CfnConnectPeerProps
- type CfnConnectPeer_BgpOptionsProperty
- type CfnConnectPeer_ConnectPeerBgpConfigurationProperty
- type CfnConnectPeer_ConnectPeerConfigurationProperty
- type CfnCoreNetwork
- type CfnCoreNetworkProps
- type CfnCoreNetwork_CoreNetworkEdgeProperty
- type CfnCoreNetwork_CoreNetworkSegmentProperty
- type CfnCustomerGatewayAssociation
- type CfnCustomerGatewayAssociationProps
- type CfnDevice
- type CfnDeviceProps
- type CfnDevice_LocationProperty
- type CfnGlobalNetwork
- type CfnGlobalNetworkProps
- type CfnLink
- type CfnLinkAssociation
- type CfnLinkAssociationProps
- type CfnLinkProps
- type CfnLink_BandwidthProperty
- type CfnSite
- type CfnSiteProps
- type CfnSiteToSiteVpnAttachment
- type CfnSiteToSiteVpnAttachmentProps
- type CfnSiteToSiteVpnAttachment_ProposedSegmentChangeProperty
- type CfnSite_LocationProperty
- type CfnTransitGatewayPeering
- type CfnTransitGatewayPeeringProps
- type CfnTransitGatewayRegistration
- type CfnTransitGatewayRegistrationProps
- type CfnTransitGatewayRouteTableAttachment
- type CfnTransitGatewayRouteTableAttachmentProps
- type CfnTransitGatewayRouteTableAttachment_ProposedSegmentChangeProperty
- type CfnVpcAttachment
- type CfnVpcAttachmentProps
- type CfnVpcAttachment_ProposedSegmentChangeProperty
- type CfnVpcAttachment_VpcOptionsProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnConnectAttachment_CFN_RESOURCE_TYPE_NAME ¶ added in v2.25.0
func CfnConnectAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnConnectAttachment_IsCfnElement ¶ added in v2.25.0
func CfnConnectAttachment_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnConnectAttachment_IsCfnResource ¶ added in v2.25.0
func CfnConnectAttachment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnConnectAttachment_IsConstruct ¶ added in v2.25.0
func CfnConnectAttachment_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnConnectPeer_CFN_RESOURCE_TYPE_NAME ¶ added in v2.25.0
func CfnConnectPeer_CFN_RESOURCE_TYPE_NAME() *string
func CfnConnectPeer_IsCfnElement ¶ added in v2.25.0
func CfnConnectPeer_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnConnectPeer_IsCfnResource ¶ added in v2.25.0
func CfnConnectPeer_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnConnectPeer_IsConstruct ¶ added in v2.25.0
func CfnConnectPeer_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCoreNetwork_CFN_RESOURCE_TYPE_NAME ¶ added in v2.25.0
func CfnCoreNetwork_CFN_RESOURCE_TYPE_NAME() *string
func CfnCoreNetwork_IsCfnElement ¶ added in v2.25.0
func CfnCoreNetwork_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCoreNetwork_IsCfnResource ¶ added in v2.25.0
func CfnCoreNetwork_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCoreNetwork_IsConstruct ¶ added in v2.25.0
func CfnCoreNetwork_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCustomerGatewayAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnCustomerGatewayAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnCustomerGatewayAssociation_IsCfnElement ¶
func CfnCustomerGatewayAssociation_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCustomerGatewayAssociation_IsCfnResource ¶
func CfnCustomerGatewayAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCustomerGatewayAssociation_IsConstruct ¶
func CfnCustomerGatewayAssociation_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnDevice_CFN_RESOURCE_TYPE_NAME ¶
func CfnDevice_CFN_RESOURCE_TYPE_NAME() *string
func CfnDevice_IsCfnElement ¶
func CfnDevice_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDevice_IsCfnResource ¶
func CfnDevice_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDevice_IsConstruct ¶
func CfnDevice_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnGlobalNetwork_CFN_RESOURCE_TYPE_NAME ¶
func CfnGlobalNetwork_CFN_RESOURCE_TYPE_NAME() *string
func CfnGlobalNetwork_IsCfnElement ¶
func CfnGlobalNetwork_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGlobalNetwork_IsCfnResource ¶
func CfnGlobalNetwork_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGlobalNetwork_IsConstruct ¶
func CfnGlobalNetwork_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnLinkAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnLinkAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnLinkAssociation_IsCfnElement ¶
func CfnLinkAssociation_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLinkAssociation_IsCfnResource ¶
func CfnLinkAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLinkAssociation_IsConstruct ¶
func CfnLinkAssociation_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnLink_CFN_RESOURCE_TYPE_NAME ¶
func CfnLink_CFN_RESOURCE_TYPE_NAME() *string
func CfnLink_IsCfnElement ¶
func CfnLink_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLink_IsCfnResource ¶
func CfnLink_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLink_IsConstruct ¶
func CfnLink_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSiteToSiteVpnAttachment_CFN_RESOURCE_TYPE_NAME ¶ added in v2.25.0
func CfnSiteToSiteVpnAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnSiteToSiteVpnAttachment_IsCfnElement ¶ added in v2.25.0
func CfnSiteToSiteVpnAttachment_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSiteToSiteVpnAttachment_IsCfnResource ¶ added in v2.25.0
func CfnSiteToSiteVpnAttachment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSiteToSiteVpnAttachment_IsConstruct ¶ added in v2.25.0
func CfnSiteToSiteVpnAttachment_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSite_CFN_RESOURCE_TYPE_NAME ¶
func CfnSite_CFN_RESOURCE_TYPE_NAME() *string
func CfnSite_IsCfnElement ¶
func CfnSite_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSite_IsCfnResource ¶
func CfnSite_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSite_IsConstruct ¶
func CfnSite_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTransitGatewayPeering_CFN_RESOURCE_TYPE_NAME ¶ added in v2.70.0
func CfnTransitGatewayPeering_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayPeering_IsCfnElement ¶ added in v2.70.0
func CfnTransitGatewayPeering_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTransitGatewayPeering_IsCfnResource ¶ added in v2.70.0
func CfnTransitGatewayPeering_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnTransitGatewayPeering_IsConstruct ¶ added in v2.70.0
func CfnTransitGatewayPeering_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTransitGatewayRegistration_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayRegistration_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayRegistration_IsCfnElement ¶
func CfnTransitGatewayRegistration_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTransitGatewayRegistration_IsCfnResource ¶
func CfnTransitGatewayRegistration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnTransitGatewayRegistration_IsConstruct ¶
func CfnTransitGatewayRegistration_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTransitGatewayRouteTableAttachment_CFN_RESOURCE_TYPE_NAME ¶ added in v2.70.0
func CfnTransitGatewayRouteTableAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayRouteTableAttachment_IsCfnElement ¶ added in v2.70.0
func CfnTransitGatewayRouteTableAttachment_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTransitGatewayRouteTableAttachment_IsCfnResource ¶ added in v2.70.0
func CfnTransitGatewayRouteTableAttachment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnTransitGatewayRouteTableAttachment_IsConstruct ¶ added in v2.70.0
func CfnTransitGatewayRouteTableAttachment_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnVpcAttachment_CFN_RESOURCE_TYPE_NAME ¶ added in v2.25.0
func CfnVpcAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnVpcAttachment_IsCfnElement ¶ added in v2.25.0
func CfnVpcAttachment_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnVpcAttachment_IsCfnResource ¶ added in v2.25.0
func CfnVpcAttachment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnVpcAttachment_IsConstruct ¶ added in v2.25.0
func CfnVpcAttachment_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnConnectAttachment_Override ¶ added in v2.25.0
func NewCfnConnectAttachment_Override(c CfnConnectAttachment, scope constructs.Construct, id *string, props *CfnConnectAttachmentProps)
Create a new `AWS::NetworkManager::ConnectAttachment`.
func NewCfnConnectPeer_Override ¶ added in v2.25.0
func NewCfnConnectPeer_Override(c CfnConnectPeer, scope constructs.Construct, id *string, props *CfnConnectPeerProps)
Create a new `AWS::NetworkManager::ConnectPeer`.
func NewCfnCoreNetwork_Override ¶ added in v2.25.0
func NewCfnCoreNetwork_Override(c CfnCoreNetwork, scope constructs.Construct, id *string, props *CfnCoreNetworkProps)
Create a new `AWS::NetworkManager::CoreNetwork`.
func NewCfnCustomerGatewayAssociation_Override ¶
func NewCfnCustomerGatewayAssociation_Override(c CfnCustomerGatewayAssociation, scope constructs.Construct, id *string, props *CfnCustomerGatewayAssociationProps)
Create a new `AWS::NetworkManager::CustomerGatewayAssociation`.
func NewCfnDevice_Override ¶
func NewCfnDevice_Override(c CfnDevice, scope constructs.Construct, id *string, props *CfnDeviceProps)
Create a new `AWS::NetworkManager::Device`.
func NewCfnGlobalNetwork_Override ¶
func NewCfnGlobalNetwork_Override(c CfnGlobalNetwork, scope constructs.Construct, id *string, props *CfnGlobalNetworkProps)
Create a new `AWS::NetworkManager::GlobalNetwork`.
func NewCfnLinkAssociation_Override ¶
func NewCfnLinkAssociation_Override(c CfnLinkAssociation, scope constructs.Construct, id *string, props *CfnLinkAssociationProps)
Create a new `AWS::NetworkManager::LinkAssociation`.
func NewCfnLink_Override ¶
func NewCfnLink_Override(c CfnLink, scope constructs.Construct, id *string, props *CfnLinkProps)
Create a new `AWS::NetworkManager::Link`.
func NewCfnSiteToSiteVpnAttachment_Override ¶ added in v2.25.0
func NewCfnSiteToSiteVpnAttachment_Override(c CfnSiteToSiteVpnAttachment, scope constructs.Construct, id *string, props *CfnSiteToSiteVpnAttachmentProps)
Create a new `AWS::NetworkManager::SiteToSiteVpnAttachment`.
func NewCfnSite_Override ¶
func NewCfnSite_Override(c CfnSite, scope constructs.Construct, id *string, props *CfnSiteProps)
Create a new `AWS::NetworkManager::Site`.
func NewCfnTransitGatewayPeering_Override ¶ added in v2.70.0
func NewCfnTransitGatewayPeering_Override(c CfnTransitGatewayPeering, scope constructs.Construct, id *string, props *CfnTransitGatewayPeeringProps)
Create a new `AWS::NetworkManager::TransitGatewayPeering`.
func NewCfnTransitGatewayRegistration_Override ¶
func NewCfnTransitGatewayRegistration_Override(c CfnTransitGatewayRegistration, scope constructs.Construct, id *string, props *CfnTransitGatewayRegistrationProps)
Create a new `AWS::NetworkManager::TransitGatewayRegistration`.
func NewCfnTransitGatewayRouteTableAttachment_Override ¶ added in v2.70.0
func NewCfnTransitGatewayRouteTableAttachment_Override(c CfnTransitGatewayRouteTableAttachment, scope constructs.Construct, id *string, props *CfnTransitGatewayRouteTableAttachmentProps)
Create a new `AWS::NetworkManager::TransitGatewayRouteTableAttachment`.
func NewCfnVpcAttachment_Override ¶ added in v2.25.0
func NewCfnVpcAttachment_Override(c CfnVpcAttachment, scope constructs.Construct, id *string, props *CfnVpcAttachmentProps)
Create a new `AWS::NetworkManager::VpcAttachment`.
Types ¶
type CfnConnectAttachment ¶ added in v2.25.0
type CfnConnectAttachment interface { awscdk.CfnResource awscdk.IInspectable // The ID of the Connect attachment. AttrAttachmentId() *string // The rule number associated with the attachment. AttrAttachmentPolicyRuleNumber() *float64 // The type of attachment. // // This will be `CONNECT` . AttrAttachmentType() *string // The ARN of the core network. AttrCoreNetworkArn() *string // The timestamp when the Connect attachment was created. AttrCreatedAt() *string // The ID of the Connect attachment owner. AttrOwnerAccountId() *string // The resource ARN for the Connect attachment. AttrResourceArn() *string // The name of the Connect attachment's segment. AttrSegmentName() *string // The state of the Connect attachment. // // This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING` . AttrState() *string // The timestamp when the Connect attachment was last updated. AttrUpdatedAt() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The ID of the core network where the Connect attachment is located. CoreNetworkId() *string SetCoreNetworkId(val *string) // Returns: 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. CreationStack() *[]*string // The Region where the edge is located. EdgeLocation() *string SetEdgeLocation(val *string) // 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. LogicalId() *string // The tree node. Node() constructs.Node // Options for connecting an attachment. Options() interface{} SetOptions(val interface{}) // `AWS::NetworkManager::ConnectAttachment.ProposedSegmentChange`. ProposedSegmentChange() interface{} SetProposedSegmentChange(val interface{}) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // `AWS::NetworkManager::ConnectAttachment.Tags`. Tags() awscdk.TagManager // The ID of the transport attachment. TransportAttachmentId() *string SetTransportAttachmentId(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::ConnectAttachment`.
Creates a core network Connect attachment from a specified core network attachment.
A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConnectAttachment := awscdk.Aws_networkmanager.NewCfnConnectAttachment(this, jsii.String("MyCfnConnectAttachment"), &CfnConnectAttachmentProps{ CoreNetworkId: jsii.String("coreNetworkId"), EdgeLocation: jsii.String("edgeLocation"), Options: &ConnectAttachmentOptionsProperty{ Protocol: jsii.String("protocol"), }, TransportAttachmentId: jsii.String("transportAttachmentId"), // the properties below are optional ProposedSegmentChange: &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, Tags: []*cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnConnectAttachment ¶ added in v2.25.0
func NewCfnConnectAttachment(scope constructs.Construct, id *string, props *CfnConnectAttachmentProps) CfnConnectAttachment
Create a new `AWS::NetworkManager::ConnectAttachment`.
type CfnConnectAttachmentProps ¶ added in v2.25.0
type CfnConnectAttachmentProps struct { // The ID of the core network where the Connect attachment is located. CoreNetworkId *string `field:"required" json:"coreNetworkId" yaml:"coreNetworkId"` // The Region where the edge is located. EdgeLocation *string `field:"required" json:"edgeLocation" yaml:"edgeLocation"` // Options for connecting an attachment. Options interface{} `field:"required" json:"options" yaml:"options"` // The ID of the transport attachment. TransportAttachmentId *string `field:"required" json:"transportAttachmentId" yaml:"transportAttachmentId"` // `AWS::NetworkManager::ConnectAttachment.ProposedSegmentChange`. ProposedSegmentChange interface{} `field:"optional" json:"proposedSegmentChange" yaml:"proposedSegmentChange"` // `AWS::NetworkManager::ConnectAttachment.Tags`. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnConnectAttachment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConnectAttachmentProps := &CfnConnectAttachmentProps{ CoreNetworkId: jsii.String("coreNetworkId"), EdgeLocation: jsii.String("edgeLocation"), Options: &ConnectAttachmentOptionsProperty{ Protocol: jsii.String("protocol"), }, TransportAttachmentId: jsii.String("transportAttachmentId"), // the properties below are optional ProposedSegmentChange: &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, Tags: []*cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnConnectAttachment_ConnectAttachmentOptionsProperty ¶ added in v2.25.0
type CfnConnectAttachment_ConnectAttachmentOptionsProperty struct { // The protocol used for the attachment connection. Protocol *string `field:"optional" json:"protocol" yaml:"protocol"` }
Describes a core network Connect attachment options.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" connectAttachmentOptionsProperty := &ConnectAttachmentOptionsProperty{ Protocol: jsii.String("protocol"), }
type CfnConnectAttachment_ProposedSegmentChangeProperty ¶ added in v2.55.0
type CfnConnectAttachment_ProposedSegmentChangeProperty struct { // The rule number in the policy document that applies to this change. AttachmentPolicyRuleNumber *float64 `field:"optional" json:"attachmentPolicyRuleNumber" yaml:"attachmentPolicyRuleNumber"` // The name of the segment to change. SegmentName *string `field:"optional" json:"segmentName" yaml:"segmentName"` // The list of key-value tags that changed for the segment. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Describes a proposed segment change.
In some cases, the segment change must first be evaluated and accepted.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" proposedSegmentChangeProperty := &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnConnectPeer ¶ added in v2.25.0
type CfnConnectPeer interface { awscdk.CfnResource awscdk.IInspectable AttrConfigurationBgpConfigurations() awscdk.IResolvable AttrConfigurationCoreNetworkAddress() *string AttrConfigurationInsideCidrBlocks() *[]*string AttrConfigurationPeerAddress() *string AttrConfigurationProtocol() *string // The ID of the Connect peer. AttrConnectPeerId() *string // The core network ID. AttrCoreNetworkId() *string // The timestamp when the Connect peer was created. AttrCreatedAt() *string // The Region where the edge is located. AttrEdgeLocation() *string // The state of the Connect peer. // // This will be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING` . AttrState() *string // `AWS::NetworkManager::ConnectPeer.BgpOptions`. BgpOptions() interface{} SetBgpOptions(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The ID of the attachment to connect. ConnectAttachmentId() *string SetConnectAttachmentId(val *string) // The IP address of a core network. CoreNetworkAddress() *string SetCoreNetworkAddress(val *string) // Returns: 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. CreationStack() *[]*string // The inside IP addresses used for a Connect peer configuration. InsideCidrBlocks() *[]*string SetInsideCidrBlocks(val *[]*string) // 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. LogicalId() *string // The tree node. Node() constructs.Node // The IP address of the Connect peer. PeerAddress() *string SetPeerAddress(val *string) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The list of key-value tags associated with the Connect peer. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::ConnectPeer`.
Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConnectPeer := awscdk.Aws_networkmanager.NewCfnConnectPeer(this, jsii.String("MyCfnConnectPeer"), &CfnConnectPeerProps{ ConnectAttachmentId: jsii.String("connectAttachmentId"), InsideCidrBlocks: []*string{ jsii.String("insideCidrBlocks"), }, PeerAddress: jsii.String("peerAddress"), // the properties below are optional BgpOptions: &BgpOptionsProperty{ PeerAsn: jsii.Number(123), }, CoreNetworkAddress: jsii.String("coreNetworkAddress"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnConnectPeer ¶ added in v2.25.0
func NewCfnConnectPeer(scope constructs.Construct, id *string, props *CfnConnectPeerProps) CfnConnectPeer
Create a new `AWS::NetworkManager::ConnectPeer`.
type CfnConnectPeerProps ¶ added in v2.25.0
type CfnConnectPeerProps struct { // The ID of the attachment to connect. ConnectAttachmentId *string `field:"required" json:"connectAttachmentId" yaml:"connectAttachmentId"` // The inside IP addresses used for a Connect peer configuration. InsideCidrBlocks *[]*string `field:"required" json:"insideCidrBlocks" yaml:"insideCidrBlocks"` // The IP address of the Connect peer. PeerAddress *string `field:"required" json:"peerAddress" yaml:"peerAddress"` // `AWS::NetworkManager::ConnectPeer.BgpOptions`. BgpOptions interface{} `field:"optional" json:"bgpOptions" yaml:"bgpOptions"` // The IP address of a core network. CoreNetworkAddress *string `field:"optional" json:"coreNetworkAddress" yaml:"coreNetworkAddress"` // The list of key-value tags associated with the Connect peer. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnConnectPeer`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConnectPeerProps := &CfnConnectPeerProps{ ConnectAttachmentId: jsii.String("connectAttachmentId"), InsideCidrBlocks: []*string{ jsii.String("insideCidrBlocks"), }, PeerAddress: jsii.String("peerAddress"), // the properties below are optional BgpOptions: &BgpOptionsProperty{ PeerAsn: jsii.Number(123), }, CoreNetworkAddress: jsii.String("coreNetworkAddress"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnConnectPeer_BgpOptionsProperty ¶ added in v2.25.0
type CfnConnectPeer_BgpOptionsProperty struct { // The Peer ASN of the BGP. PeerAsn *float64 `field:"optional" json:"peerAsn" yaml:"peerAsn"` }
Describes the BGP options.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" bgpOptionsProperty := &BgpOptionsProperty{ PeerAsn: jsii.Number(123), }
type CfnConnectPeer_ConnectPeerBgpConfigurationProperty ¶ added in v2.55.0
type CfnConnectPeer_ConnectPeerBgpConfigurationProperty struct { // The address of a core network. CoreNetworkAddress *string `field:"optional" json:"coreNetworkAddress" yaml:"coreNetworkAddress"` // The ASN of the Coret Network. CoreNetworkAsn *float64 `field:"optional" json:"coreNetworkAsn" yaml:"coreNetworkAsn"` // The address of a core network Connect peer. PeerAddress *string `field:"optional" json:"peerAddress" yaml:"peerAddress"` // The ASN of the Connect peer. PeerAsn *float64 `field:"optional" json:"peerAsn" yaml:"peerAsn"` }
Describes a core network BGP configuration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" connectPeerBgpConfigurationProperty := &ConnectPeerBgpConfigurationProperty{ CoreNetworkAddress: jsii.String("coreNetworkAddress"), CoreNetworkAsn: jsii.Number(123), PeerAddress: jsii.String("peerAddress"), PeerAsn: jsii.Number(123), }
type CfnConnectPeer_ConnectPeerConfigurationProperty ¶ added in v2.55.0
type CfnConnectPeer_ConnectPeerConfigurationProperty struct { // The Connect peer BGP configurations. BgpConfigurations interface{} `field:"optional" json:"bgpConfigurations" yaml:"bgpConfigurations"` // The IP address of a core network. CoreNetworkAddress *string `field:"optional" json:"coreNetworkAddress" yaml:"coreNetworkAddress"` // The inside IP addresses used for a Connect peer configuration. InsideCidrBlocks *[]*string `field:"optional" json:"insideCidrBlocks" yaml:"insideCidrBlocks"` // The IP address of the Connect peer. PeerAddress *string `field:"optional" json:"peerAddress" yaml:"peerAddress"` // The protocol used for a Connect peer configuration. Protocol *string `field:"optional" json:"protocol" yaml:"protocol"` }
Describes a core network Connect peer configuration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" connectPeerConfigurationProperty := &ConnectPeerConfigurationProperty{ BgpConfigurations: []interface{}{ &ConnectPeerBgpConfigurationProperty{ CoreNetworkAddress: jsii.String("coreNetworkAddress"), CoreNetworkAsn: jsii.Number(123), PeerAddress: jsii.String("peerAddress"), PeerAsn: jsii.Number(123), }, }, CoreNetworkAddress: jsii.String("coreNetworkAddress"), InsideCidrBlocks: []*string{ jsii.String("insideCidrBlocks"), }, PeerAddress: jsii.String("peerAddress"), Protocol: jsii.String("protocol"), }
type CfnCoreNetwork ¶ added in v2.25.0
type CfnCoreNetwork interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the core network. AttrCoreNetworkArn() *string // The ID of the core network. AttrCoreNetworkId() *string // The timestamp when the core network was created. AttrCreatedAt() *string // The edges. AttrEdges() awscdk.IResolvable AttrOwnerAccount() *string // The segments. AttrSegments() awscdk.IResolvable // The current state of the core network. // // These states are: `CREATING` | `UPDATING` | `AVAILABLE` | `DELETING` . AttrState() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // The description of a core network. Description() *string SetDescription(val *string) // The ID of the global network that your core network is a part of. GlobalNetworkId() *string SetGlobalNetworkId(val *string) // 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. LogicalId() *string // The tree node. Node() constructs.Node // Describes a core network policy. For more information, see [Core network policies](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-policy-change-sets.html) . // // If you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy. PolicyDocument() interface{} SetPolicyDocument(val interface{}) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The list of key-value tags associated with a core network. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::CoreNetwork`.
Describes a core network.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var policyDocument interface{} cfnCoreNetwork := awscdk.Aws_networkmanager.NewCfnCoreNetwork(this, jsii.String("MyCfnCoreNetwork"), &CfnCoreNetworkProps{ GlobalNetworkId: jsii.String("globalNetworkId"), // the properties below are optional Description: jsii.String("description"), PolicyDocument: policyDocument, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnCoreNetwork ¶ added in v2.25.0
func NewCfnCoreNetwork(scope constructs.Construct, id *string, props *CfnCoreNetworkProps) CfnCoreNetwork
Create a new `AWS::NetworkManager::CoreNetwork`.
type CfnCoreNetworkProps ¶ added in v2.25.0
type CfnCoreNetworkProps struct { // The ID of the global network that your core network is a part of. GlobalNetworkId *string `field:"required" json:"globalNetworkId" yaml:"globalNetworkId"` // The description of a core network. Description *string `field:"optional" json:"description" yaml:"description"` // Describes a core network policy. For more information, see [Core network policies](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-policy-change-sets.html) . // // If you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy. PolicyDocument interface{} `field:"optional" json:"policyDocument" yaml:"policyDocument"` // The list of key-value tags associated with a core network. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnCoreNetwork`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var policyDocument interface{} cfnCoreNetworkProps := &CfnCoreNetworkProps{ GlobalNetworkId: jsii.String("globalNetworkId"), // the properties below are optional Description: jsii.String("description"), PolicyDocument: policyDocument, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnCoreNetwork_CoreNetworkEdgeProperty ¶ added in v2.25.0
type CfnCoreNetwork_CoreNetworkEdgeProperty struct { // The ASN of a core network edge. Asn *float64 `field:"optional" json:"asn" yaml:"asn"` // The Region where a core network edge is located. EdgeLocation *string `field:"optional" json:"edgeLocation" yaml:"edgeLocation"` // The inside IP addresses used for core network edges. InsideCidrBlocks *[]*string `field:"optional" json:"insideCidrBlocks" yaml:"insideCidrBlocks"` }
Describes a core network edge.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" coreNetworkEdgeProperty := &CoreNetworkEdgeProperty{ Asn: jsii.Number(123), EdgeLocation: jsii.String("edgeLocation"), InsideCidrBlocks: []*string{ jsii.String("insideCidrBlocks"), }, }
type CfnCoreNetwork_CoreNetworkSegmentProperty ¶ added in v2.25.0
type CfnCoreNetwork_CoreNetworkSegmentProperty struct { // The Regions where the edges are located. EdgeLocations *[]*string `field:"optional" json:"edgeLocations" yaml:"edgeLocations"` // The name of a core network segment. Name *string `field:"optional" json:"name" yaml:"name"` SharedSegments *[]*string `field:"optional" json:"sharedSegments" yaml:"sharedSegments"` }
Describes a core network segment, which are dedicated routes.
Only attachments within this segment can communicate with each other.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" coreNetworkSegmentProperty := &CoreNetworkSegmentProperty{ EdgeLocations: []*string{ jsii.String("edgeLocations"), }, Name: jsii.String("name"), SharedSegments: []*string{ jsii.String("sharedSegments"), }, }
type CfnCustomerGatewayAssociation ¶
type CfnCustomerGatewayAssociation interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // The Amazon Resource Name (ARN) of the customer gateway. CustomerGatewayArn() *string SetCustomerGatewayArn(val *string) // The ID of the device. DeviceId() *string SetDeviceId(val *string) // The ID of the global network. GlobalNetworkId() *string SetGlobalNetworkId(val *string) // The ID of the link. LinkId() *string SetLinkId(val *string) // 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. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::CustomerGatewayAssociation`.
Specifies an association between a customer gateway, a device, and optionally, a link. If you specify a link, it must be associated with the specified device. The customer gateway must be connected to a VPN attachment on a transit gateway that's registered in your global network.
You cannot associate a customer gateway with more than one device and link.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCustomerGatewayAssociation := awscdk.Aws_networkmanager.NewCfnCustomerGatewayAssociation(this, jsii.String("MyCfnCustomerGatewayAssociation"), &CfnCustomerGatewayAssociationProps{ CustomerGatewayArn: jsii.String("customerGatewayArn"), DeviceId: jsii.String("deviceId"), GlobalNetworkId: jsii.String("globalNetworkId"), // the properties below are optional LinkId: jsii.String("linkId"), })
func NewCfnCustomerGatewayAssociation ¶
func NewCfnCustomerGatewayAssociation(scope constructs.Construct, id *string, props *CfnCustomerGatewayAssociationProps) CfnCustomerGatewayAssociation
Create a new `AWS::NetworkManager::CustomerGatewayAssociation`.
type CfnCustomerGatewayAssociationProps ¶
type CfnCustomerGatewayAssociationProps struct { // The Amazon Resource Name (ARN) of the customer gateway. CustomerGatewayArn *string `field:"required" json:"customerGatewayArn" yaml:"customerGatewayArn"` // The ID of the device. DeviceId *string `field:"required" json:"deviceId" yaml:"deviceId"` // The ID of the global network. GlobalNetworkId *string `field:"required" json:"globalNetworkId" yaml:"globalNetworkId"` // The ID of the link. LinkId *string `field:"optional" json:"linkId" yaml:"linkId"` }
Properties for defining a `CfnCustomerGatewayAssociation`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCustomerGatewayAssociationProps := &CfnCustomerGatewayAssociationProps{ CustomerGatewayArn: jsii.String("customerGatewayArn"), DeviceId: jsii.String("deviceId"), GlobalNetworkId: jsii.String("globalNetworkId"), // the properties below are optional LinkId: jsii.String("linkId"), }
type CfnDevice ¶
type CfnDevice interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the device. // // For example, `arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123` . AttrDeviceArn() *string // The ID of the device. // // For example, `device-07f6fd08867abc123` . AttrDeviceId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // A description of the device. // // Constraints: Maximum length of 256 characters. Description() *string SetDescription(val *string) // The ID of the global network. GlobalNetworkId() *string SetGlobalNetworkId(val *string) // The site location. Location() interface{} SetLocation(val interface{}) // 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. LogicalId() *string // The model of the device. // // Constraints: Maximum length of 128 characters. Model() *string SetModel(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The serial number of the device. // // Constraints: Maximum length of 128 characters. SerialNumber() *string SetSerialNumber(val *string) // The site ID. SiteId() *string SetSiteId(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags for the device. Tags() awscdk.TagManager // The device type. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The vendor of the device. // // Constraints: Maximum length of 128 characters. Vendor() *string SetVendor(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::Device`.
Specifies a device.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDevice := awscdk.Aws_networkmanager.NewCfnDevice(this, jsii.String("MyCfnDevice"), &CfnDeviceProps{ GlobalNetworkId: jsii.String("globalNetworkId"), // the properties below are optional Description: jsii.String("description"), Location: &LocationProperty{ Address: jsii.String("address"), Latitude: jsii.String("latitude"), Longitude: jsii.String("longitude"), }, Model: jsii.String("model"), SerialNumber: jsii.String("serialNumber"), SiteId: jsii.String("siteId"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, Type: jsii.String("type"), Vendor: jsii.String("vendor"), })
func NewCfnDevice ¶
func NewCfnDevice(scope constructs.Construct, id *string, props *CfnDeviceProps) CfnDevice
Create a new `AWS::NetworkManager::Device`.
type CfnDeviceProps ¶
type CfnDeviceProps struct { // The ID of the global network. GlobalNetworkId *string `field:"required" json:"globalNetworkId" yaml:"globalNetworkId"` // A description of the device. // // Constraints: Maximum length of 256 characters. Description *string `field:"optional" json:"description" yaml:"description"` // The site location. Location interface{} `field:"optional" json:"location" yaml:"location"` // The model of the device. // // Constraints: Maximum length of 128 characters. Model *string `field:"optional" json:"model" yaml:"model"` // The serial number of the device. // // Constraints: Maximum length of 128 characters. SerialNumber *string `field:"optional" json:"serialNumber" yaml:"serialNumber"` // The site ID. SiteId *string `field:"optional" json:"siteId" yaml:"siteId"` // The tags for the device. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The device type. Type *string `field:"optional" json:"type" yaml:"type"` // The vendor of the device. // // Constraints: Maximum length of 128 characters. Vendor *string `field:"optional" json:"vendor" yaml:"vendor"` }
Properties for defining a `CfnDevice`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDeviceProps := &CfnDeviceProps{ GlobalNetworkId: jsii.String("globalNetworkId"), // the properties below are optional Description: jsii.String("description"), Location: &LocationProperty{ Address: jsii.String("address"), Latitude: jsii.String("latitude"), Longitude: jsii.String("longitude"), }, Model: jsii.String("model"), SerialNumber: jsii.String("serialNumber"), SiteId: jsii.String("siteId"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, Type: jsii.String("type"), Vendor: jsii.String("vendor"), }
type CfnDevice_LocationProperty ¶
type CfnDevice_LocationProperty struct { // The physical address. Address *string `field:"optional" json:"address" yaml:"address"` // The latitude. Latitude *string `field:"optional" json:"latitude" yaml:"latitude"` // The longitude. Longitude *string `field:"optional" json:"longitude" yaml:"longitude"` }
Describes a location.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" locationProperty := &LocationProperty{ Address: jsii.String("address"), Latitude: jsii.String("latitude"), Longitude: jsii.String("longitude"), }
type CfnGlobalNetwork ¶
type CfnGlobalNetwork interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the global network. // // For example, `arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231` . AttrArn() *string // The ID of the global network. // // For example, `global-network-01231231231231231` . AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // A description of the global network. // // Constraints: Maximum length of 256 characters. Description() *string SetDescription(val *string) // 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. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags for the global network. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::GlobalNetwork`.
Creates a new, empty global network.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnGlobalNetwork := awscdk.Aws_networkmanager.NewCfnGlobalNetwork(this, jsii.String("MyCfnGlobalNetwork"), &CfnGlobalNetworkProps{ Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnGlobalNetwork ¶
func NewCfnGlobalNetwork(scope constructs.Construct, id *string, props *CfnGlobalNetworkProps) CfnGlobalNetwork
Create a new `AWS::NetworkManager::GlobalNetwork`.
type CfnGlobalNetworkProps ¶
type CfnGlobalNetworkProps struct { // A description of the global network. // // Constraints: Maximum length of 256 characters. Description *string `field:"optional" json:"description" yaml:"description"` // The tags for the global network. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnGlobalNetwork`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnGlobalNetworkProps := &CfnGlobalNetworkProps{ Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnLink ¶
type CfnLink interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the link. // // For example, `arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1` . AttrLinkArn() *string // The ID of the link. // // For example, `link-11112222aaaabbbb1` . AttrLinkId() *string // The bandwidth for the link. Bandwidth() interface{} SetBandwidth(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // A description of the link. // // Constraints: Maximum length of 256 characters. Description() *string SetDescription(val *string) // The ID of the global network. GlobalNetworkId() *string SetGlobalNetworkId(val *string) // 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. LogicalId() *string // The tree node. Node() constructs.Node // The provider of the link. // // Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^ Provider() *string SetProvider(val *string) // 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 })`. Ref() *string // The ID of the site. SiteId() *string SetSiteId(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags for the link. Tags() awscdk.TagManager // The type of the link. // // Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^ Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::Link`.
Specifies a link for a site.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLink := awscdk.Aws_networkmanager.NewCfnLink(this, jsii.String("MyCfnLink"), &CfnLinkProps{ Bandwidth: &BandwidthProperty{ DownloadSpeed: jsii.Number(123), UploadSpeed: jsii.Number(123), }, GlobalNetworkId: jsii.String("globalNetworkId"), SiteId: jsii.String("siteId"), // the properties below are optional Description: jsii.String("description"), Provider: jsii.String("provider"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, Type: jsii.String("type"), })
func NewCfnLink ¶
func NewCfnLink(scope constructs.Construct, id *string, props *CfnLinkProps) CfnLink
Create a new `AWS::NetworkManager::Link`.
type CfnLinkAssociation ¶
type CfnLinkAssociation interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // The device ID for the link association. DeviceId() *string SetDeviceId(val *string) // The ID of the global network. GlobalNetworkId() *string SetGlobalNetworkId(val *string) // The ID of the link. LinkId() *string SetLinkId(val *string) // 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. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::LinkAssociation`.
Describes the association between a device and a link.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLinkAssociation := awscdk.Aws_networkmanager.NewCfnLinkAssociation(this, jsii.String("MyCfnLinkAssociation"), &CfnLinkAssociationProps{ DeviceId: jsii.String("deviceId"), GlobalNetworkId: jsii.String("globalNetworkId"), LinkId: jsii.String("linkId"), })
func NewCfnLinkAssociation ¶
func NewCfnLinkAssociation(scope constructs.Construct, id *string, props *CfnLinkAssociationProps) CfnLinkAssociation
Create a new `AWS::NetworkManager::LinkAssociation`.
type CfnLinkAssociationProps ¶
type CfnLinkAssociationProps struct { // The device ID for the link association. DeviceId *string `field:"required" json:"deviceId" yaml:"deviceId"` // The ID of the global network. GlobalNetworkId *string `field:"required" json:"globalNetworkId" yaml:"globalNetworkId"` // The ID of the link. LinkId *string `field:"required" json:"linkId" yaml:"linkId"` }
Properties for defining a `CfnLinkAssociation`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLinkAssociationProps := &CfnLinkAssociationProps{ DeviceId: jsii.String("deviceId"), GlobalNetworkId: jsii.String("globalNetworkId"), LinkId: jsii.String("linkId"), }
type CfnLinkProps ¶
type CfnLinkProps struct { // The bandwidth for the link. Bandwidth interface{} `field:"required" json:"bandwidth" yaml:"bandwidth"` // The ID of the global network. GlobalNetworkId *string `field:"required" json:"globalNetworkId" yaml:"globalNetworkId"` // The ID of the site. SiteId *string `field:"required" json:"siteId" yaml:"siteId"` // A description of the link. // // Constraints: Maximum length of 256 characters. Description *string `field:"optional" json:"description" yaml:"description"` // The provider of the link. // // Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^ Provider *string `field:"optional" json:"provider" yaml:"provider"` // The tags for the link. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The type of the link. // // Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^ Type *string `field:"optional" json:"type" yaml:"type"` }
Properties for defining a `CfnLink`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLinkProps := &CfnLinkProps{ Bandwidth: &BandwidthProperty{ DownloadSpeed: jsii.Number(123), UploadSpeed: jsii.Number(123), }, GlobalNetworkId: jsii.String("globalNetworkId"), SiteId: jsii.String("siteId"), // the properties below are optional Description: jsii.String("description"), Provider: jsii.String("provider"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, Type: jsii.String("type"), }
type CfnLink_BandwidthProperty ¶
type CfnLink_BandwidthProperty struct { // Download speed in Mbps. DownloadSpeed *float64 `field:"optional" json:"downloadSpeed" yaml:"downloadSpeed"` // Upload speed in Mbps. UploadSpeed *float64 `field:"optional" json:"uploadSpeed" yaml:"uploadSpeed"` }
Describes bandwidth information.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" bandwidthProperty := &BandwidthProperty{ DownloadSpeed: jsii.Number(123), UploadSpeed: jsii.Number(123), }
type CfnSite ¶
type CfnSite interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the site. // // For example, `arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223` . AttrSiteArn() *string // The ID of the site. // // For example, `site-444555aaabbb11223` . AttrSiteId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // A description of your site. // // Constraints: Maximum length of 256 characters. Description() *string SetDescription(val *string) // The ID of the global network. GlobalNetworkId() *string SetGlobalNetworkId(val *string) // 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. Location() interface{} SetLocation(val interface{}) // 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. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags for the site. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::Site`.
Creates a new site in a global network.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSite := awscdk.Aws_networkmanager.NewCfnSite(this, jsii.String("MyCfnSite"), &CfnSiteProps{ GlobalNetworkId: jsii.String("globalNetworkId"), // the properties below are optional Description: jsii.String("description"), Location: &LocationProperty{ Address: jsii.String("address"), Latitude: jsii.String("latitude"), Longitude: jsii.String("longitude"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnSite ¶
func NewCfnSite(scope constructs.Construct, id *string, props *CfnSiteProps) CfnSite
Create a new `AWS::NetworkManager::Site`.
type CfnSiteProps ¶
type CfnSiteProps struct { // The ID of the global network. GlobalNetworkId *string `field:"required" json:"globalNetworkId" yaml:"globalNetworkId"` // A description of your site. // // Constraints: Maximum length of 256 characters. Description *string `field:"optional" json:"description" yaml:"description"` // 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. Location interface{} `field:"optional" json:"location" yaml:"location"` // The tags for the site. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSite`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSiteProps := &CfnSiteProps{ GlobalNetworkId: jsii.String("globalNetworkId"), // the properties below are optional Description: jsii.String("description"), Location: &LocationProperty{ Address: jsii.String("address"), Latitude: jsii.String("latitude"), Longitude: jsii.String("longitude"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnSiteToSiteVpnAttachment ¶ added in v2.25.0
type CfnSiteToSiteVpnAttachment interface { awscdk.CfnResource awscdk.IInspectable // The ID of the site-to-site VPN attachment. AttrAttachmentId() *string // The policy rule number associated with the attachment. AttrAttachmentPolicyRuleNumber() *float64 // The type of attachment. // // This will be `SITE_TO_SITE_VPN` . AttrAttachmentType() *string // The ARN of the core network. AttrCoreNetworkArn() *string // The timestamp when the site-to-site VPN attachment was created. AttrCreatedAt() *string // The Region where the core network edge is located. AttrEdgeLocation() *string // The ID of the site-to-site VPN attachment owner. AttrOwnerAccountId() *string // The resource ARN for the site-to-site VPN attachment. AttrResourceArn() *string // The name of the site-to-site VPN attachment's segment. AttrSegmentName() *string // The state of the site-to-site VPN attachment. // // This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING` . AttrState() *string // The timestamp when the site-to-site VPN attachment was last updated. AttrUpdatedAt() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // `AWS::NetworkManager::SiteToSiteVpnAttachment.CoreNetworkId`. CoreNetworkId() *string SetCoreNetworkId(val *string) // Returns: 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. CreationStack() *[]*string // 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. LogicalId() *string // The tree node. Node() constructs.Node // `AWS::NetworkManager::SiteToSiteVpnAttachment.ProposedSegmentChange`. ProposedSegmentChange() interface{} SetProposedSegmentChange(val interface{}) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // `AWS::NetworkManager::SiteToSiteVpnAttachment.Tags`. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ARN of the site-to-site VPN attachment. VpnConnectionArn() *string SetVpnConnectionArn(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::SiteToSiteVpnAttachment`.
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSiteToSiteVpnAttachment := awscdk.Aws_networkmanager.NewCfnSiteToSiteVpnAttachment(this, jsii.String("MyCfnSiteToSiteVpnAttachment"), &CfnSiteToSiteVpnAttachmentProps{ CoreNetworkId: jsii.String("coreNetworkId"), VpnConnectionArn: jsii.String("vpnConnectionArn"), // the properties below are optional ProposedSegmentChange: &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, Tags: []*cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnSiteToSiteVpnAttachment ¶ added in v2.25.0
func NewCfnSiteToSiteVpnAttachment(scope constructs.Construct, id *string, props *CfnSiteToSiteVpnAttachmentProps) CfnSiteToSiteVpnAttachment
Create a new `AWS::NetworkManager::SiteToSiteVpnAttachment`.
type CfnSiteToSiteVpnAttachmentProps ¶ added in v2.25.0
type CfnSiteToSiteVpnAttachmentProps struct { // `AWS::NetworkManager::SiteToSiteVpnAttachment.CoreNetworkId`. CoreNetworkId *string `field:"required" json:"coreNetworkId" yaml:"coreNetworkId"` // The ARN of the site-to-site VPN attachment. VpnConnectionArn *string `field:"required" json:"vpnConnectionArn" yaml:"vpnConnectionArn"` // `AWS::NetworkManager::SiteToSiteVpnAttachment.ProposedSegmentChange`. ProposedSegmentChange interface{} `field:"optional" json:"proposedSegmentChange" yaml:"proposedSegmentChange"` // `AWS::NetworkManager::SiteToSiteVpnAttachment.Tags`. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSiteToSiteVpnAttachment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSiteToSiteVpnAttachmentProps := &CfnSiteToSiteVpnAttachmentProps{ CoreNetworkId: jsii.String("coreNetworkId"), VpnConnectionArn: jsii.String("vpnConnectionArn"), // the properties below are optional ProposedSegmentChange: &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, Tags: []*cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnSiteToSiteVpnAttachment_ProposedSegmentChangeProperty ¶ added in v2.55.0
type CfnSiteToSiteVpnAttachment_ProposedSegmentChangeProperty struct { // The rule number in the policy document that applies to this change. AttachmentPolicyRuleNumber *float64 `field:"optional" json:"attachmentPolicyRuleNumber" yaml:"attachmentPolicyRuleNumber"` // The name of the segment to change. SegmentName *string `field:"optional" json:"segmentName" yaml:"segmentName"` // The list of key-value tags that changed for the segment. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Describes a proposed segment change.
In some cases, the segment change must first be evaluated and accepted.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" proposedSegmentChangeProperty := &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnSite_LocationProperty ¶
type CfnSite_LocationProperty struct { // The physical address. Address *string `field:"optional" json:"address" yaml:"address"` // The latitude. Latitude *string `field:"optional" json:"latitude" yaml:"latitude"` // The longitude. Longitude *string `field:"optional" json:"longitude" yaml:"longitude"` }
Describes a location.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" locationProperty := &LocationProperty{ Address: jsii.String("address"), Latitude: jsii.String("latitude"), Longitude: jsii.String("longitude"), }
type CfnTransitGatewayPeering ¶ added in v2.70.0
type CfnTransitGatewayPeering interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the core network. AttrCoreNetworkArn() *string // The timestamp when the core network peering was created. AttrCreatedAt() *string // The edge location for the peer. AttrEdgeLocation() *string // The ID of the account owner. AttrOwnerAccountId() *string // The ID of the peering. AttrPeeringId() *string // The peering type. // // This will be `TRANSIT_GATEWAY` . AttrPeeringType() *string // The ARN of the resource peered to a core network. AttrResourceArn() *string // The current state of the peer. // // This can be `CREATING` | `FAILED` | `AVAILABLE` | `DELETING` . AttrState() *string // The ID of the peering attachment. AttrTransitGatewayPeeringAttachmentId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The ID of the core network. CoreNetworkId() *string SetCoreNetworkId(val *string) // Returns: 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. CreationStack() *[]*string // 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. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The list of key-value tags associated with the peering. Tags() awscdk.TagManager // The ARN of the transit gateway. TransitGatewayArn() *string SetTransitGatewayArn(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::TransitGatewayPeering`.
Creates a transit gateway peering connection.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTransitGatewayPeering := awscdk.Aws_networkmanager.NewCfnTransitGatewayPeering(this, jsii.String("MyCfnTransitGatewayPeering"), &CfnTransitGatewayPeeringProps{ CoreNetworkId: jsii.String("coreNetworkId"), TransitGatewayArn: jsii.String("transitGatewayArn"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnTransitGatewayPeering ¶ added in v2.70.0
func NewCfnTransitGatewayPeering(scope constructs.Construct, id *string, props *CfnTransitGatewayPeeringProps) CfnTransitGatewayPeering
Create a new `AWS::NetworkManager::TransitGatewayPeering`.
type CfnTransitGatewayPeeringProps ¶ added in v2.70.0
type CfnTransitGatewayPeeringProps struct { // The ID of the core network. CoreNetworkId *string `field:"required" json:"coreNetworkId" yaml:"coreNetworkId"` // The ARN of the transit gateway. TransitGatewayArn *string `field:"required" json:"transitGatewayArn" yaml:"transitGatewayArn"` // The list of key-value tags associated with the peering. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnTransitGatewayPeering`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTransitGatewayPeeringProps := &CfnTransitGatewayPeeringProps{ CoreNetworkId: jsii.String("coreNetworkId"), TransitGatewayArn: jsii.String("transitGatewayArn"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnTransitGatewayRegistration ¶
type CfnTransitGatewayRegistration interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // The ID of the global network. GlobalNetworkId() *string SetGlobalNetworkId(val *string) // 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. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The Amazon Resource Name (ARN) of the transit gateway. TransitGatewayArn() *string SetTransitGatewayArn(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::TransitGatewayRegistration`.
Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see [Region Availability](https://docs.aws.amazon.com/network-manager/latest/tgwnm/what-are-global-networks.html#nm-available-regions) in the *AWS Transit Gateways for Global Networks User Guide* . The transit gateway can be in any of the supported AWS Regions, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTransitGatewayRegistration := awscdk.Aws_networkmanager.NewCfnTransitGatewayRegistration(this, jsii.String("MyCfnTransitGatewayRegistration"), &CfnTransitGatewayRegistrationProps{ GlobalNetworkId: jsii.String("globalNetworkId"), TransitGatewayArn: jsii.String("transitGatewayArn"), })
func NewCfnTransitGatewayRegistration ¶
func NewCfnTransitGatewayRegistration(scope constructs.Construct, id *string, props *CfnTransitGatewayRegistrationProps) CfnTransitGatewayRegistration
Create a new `AWS::NetworkManager::TransitGatewayRegistration`.
type CfnTransitGatewayRegistrationProps ¶
type CfnTransitGatewayRegistrationProps struct { // The ID of the global network. GlobalNetworkId *string `field:"required" json:"globalNetworkId" yaml:"globalNetworkId"` // The Amazon Resource Name (ARN) of the transit gateway. TransitGatewayArn *string `field:"required" json:"transitGatewayArn" yaml:"transitGatewayArn"` }
Properties for defining a `CfnTransitGatewayRegistration`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTransitGatewayRegistrationProps := &CfnTransitGatewayRegistrationProps{ GlobalNetworkId: jsii.String("globalNetworkId"), TransitGatewayArn: jsii.String("transitGatewayArn"), }
type CfnTransitGatewayRouteTableAttachment ¶ added in v2.70.0
type CfnTransitGatewayRouteTableAttachment interface { awscdk.CfnResource awscdk.IInspectable // The ID of the transit gateway route table attachment. AttrAttachmentId() *string // The policy rule number associated with the attachment. AttrAttachmentPolicyRuleNumber() *float64 // The type of attachment. // // This will be `TRANSIT_GATEWAY_ROUTE_TABLE` . AttrAttachmentType() *string // The ARN of the core network. AttrCoreNetworkArn() *string // The ID of the core network. AttrCoreNetworkId() *string // The timestamp when the transit gateway route table attachment was created. AttrCreatedAt() *string // The Region where the core network edge is located. AttrEdgeLocation() *string // The ID of the transit gateway route table attachment owner. AttrOwnerAccountId() *string // The resource ARN for the transit gateway route table attachment. AttrResourceArn() *string // The name of the attachment's segment. AttrSegmentName() *string // The state of the attachment. // // This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING` . AttrState() *string // The timestamp when the transit gateway route table attachment was last updated. AttrUpdatedAt() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // 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. LogicalId() *string // The tree node. Node() constructs.Node // The ID of the transit gateway peering. PeeringId() *string SetPeeringId(val *string) // This property is read-only. // // Values can't be assigned to it. ProposedSegmentChange() interface{} SetProposedSegmentChange(val interface{}) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The list of key-value pairs associated with the transit gateway route table attachment. Tags() awscdk.TagManager // The ARN of the transit gateway attachment route table. // // For example, `"TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456"` . TransitGatewayRouteTableArn() *string SetTransitGatewayRouteTableArn(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::TransitGatewayRouteTableAttachment`.
Creates a transit gateway route table attachment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTransitGatewayRouteTableAttachment := awscdk.Aws_networkmanager.NewCfnTransitGatewayRouteTableAttachment(this, jsii.String("MyCfnTransitGatewayRouteTableAttachment"), &CfnTransitGatewayRouteTableAttachmentProps{ PeeringId: jsii.String("peeringId"), TransitGatewayRouteTableArn: jsii.String("transitGatewayRouteTableArn"), // the properties below are optional ProposedSegmentChange: &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, Tags: []*cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnTransitGatewayRouteTableAttachment ¶ added in v2.70.0
func NewCfnTransitGatewayRouteTableAttachment(scope constructs.Construct, id *string, props *CfnTransitGatewayRouteTableAttachmentProps) CfnTransitGatewayRouteTableAttachment
Create a new `AWS::NetworkManager::TransitGatewayRouteTableAttachment`.
type CfnTransitGatewayRouteTableAttachmentProps ¶ added in v2.70.0
type CfnTransitGatewayRouteTableAttachmentProps struct { // The ID of the transit gateway peering. PeeringId *string `field:"required" json:"peeringId" yaml:"peeringId"` // The ARN of the transit gateway attachment route table. // // For example, `"TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456"` . TransitGatewayRouteTableArn *string `field:"required" json:"transitGatewayRouteTableArn" yaml:"transitGatewayRouteTableArn"` // This property is read-only. // // Values can't be assigned to it. ProposedSegmentChange interface{} `field:"optional" json:"proposedSegmentChange" yaml:"proposedSegmentChange"` // The list of key-value pairs associated with the transit gateway route table attachment. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnTransitGatewayRouteTableAttachment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTransitGatewayRouteTableAttachmentProps := &CfnTransitGatewayRouteTableAttachmentProps{ PeeringId: jsii.String("peeringId"), TransitGatewayRouteTableArn: jsii.String("transitGatewayRouteTableArn"), // the properties below are optional ProposedSegmentChange: &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, Tags: []*cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnTransitGatewayRouteTableAttachment_ProposedSegmentChangeProperty ¶ added in v2.70.0
type CfnTransitGatewayRouteTableAttachment_ProposedSegmentChangeProperty struct { // The rule number in the policy document that applies to this change. AttachmentPolicyRuleNumber *float64 `field:"optional" json:"attachmentPolicyRuleNumber" yaml:"attachmentPolicyRuleNumber"` // The name of the segment to change. SegmentName *string `field:"optional" json:"segmentName" yaml:"segmentName"` // The list of key-value tags that changed for the segment. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Describes a proposed segment change.
In some cases, the segment change must first be evaluated and accepted.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" proposedSegmentChangeProperty := &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnVpcAttachment ¶ added in v2.25.0
type CfnVpcAttachment interface { awscdk.CfnResource awscdk.IInspectable // The ID of the VPC attachment. AttrAttachmentId() *string // The policy rule number associated with the attachment. AttrAttachmentPolicyRuleNumber() *float64 // The type of attachment. // // This will be `VPC` . AttrAttachmentType() *string // The ARN of the core network. AttrCoreNetworkArn() *string // The timestamp when the VPC attachment was created. AttrCreatedAt() *string // The Region where the core network edge is located. AttrEdgeLocation() *string // The ID of the VPC attachment owner. AttrOwnerAccountId() *string // The resource ARN for the VPC attachment. AttrResourceArn() *string // The name of the attachment's segment. AttrSegmentName() *string // The state of the attachment. // // This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING` . AttrState() *string // The timestamp when the VPC attachment was last updated. AttrUpdatedAt() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The core network ID. CoreNetworkId() *string SetCoreNetworkId(val *string) // Returns: 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. CreationStack() *[]*string // 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. LogicalId() *string // The tree node. Node() constructs.Node // Options for creating the VPC attachment. Options() interface{} SetOptions(val interface{}) // `AWS::NetworkManager::VpcAttachment.ProposedSegmentChange`. ProposedSegmentChange() interface{} SetProposedSegmentChange(val interface{}) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The subnet ARNs. SubnetArns() *[]*string SetSubnetArns(val *[]*string) // The tags associated with the VPC attachment. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ARN of the VPC attachment. VpcArn() *string SetVpcArn(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::NetworkManager::VpcAttachment`.
Creates a VPC attachment on an edge location of a core network.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnVpcAttachment := awscdk.Aws_networkmanager.NewCfnVpcAttachment(this, jsii.String("MyCfnVpcAttachment"), &CfnVpcAttachmentProps{ CoreNetworkId: jsii.String("coreNetworkId"), SubnetArns: []*string{ jsii.String("subnetArns"), }, VpcArn: jsii.String("vpcArn"), // the properties below are optional Options: &VpcOptionsProperty{ ApplianceModeSupport: jsii.Boolean(false), Ipv6Support: jsii.Boolean(false), }, ProposedSegmentChange: &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, Tags: []*cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnVpcAttachment ¶ added in v2.25.0
func NewCfnVpcAttachment(scope constructs.Construct, id *string, props *CfnVpcAttachmentProps) CfnVpcAttachment
Create a new `AWS::NetworkManager::VpcAttachment`.
type CfnVpcAttachmentProps ¶ added in v2.25.0
type CfnVpcAttachmentProps struct { // The core network ID. CoreNetworkId *string `field:"required" json:"coreNetworkId" yaml:"coreNetworkId"` // The subnet ARNs. SubnetArns *[]*string `field:"required" json:"subnetArns" yaml:"subnetArns"` // The ARN of the VPC attachment. VpcArn *string `field:"required" json:"vpcArn" yaml:"vpcArn"` // Options for creating the VPC attachment. Options interface{} `field:"optional" json:"options" yaml:"options"` // `AWS::NetworkManager::VpcAttachment.ProposedSegmentChange`. ProposedSegmentChange interface{} `field:"optional" json:"proposedSegmentChange" yaml:"proposedSegmentChange"` // The tags associated with the VPC attachment. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnVpcAttachment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnVpcAttachmentProps := &CfnVpcAttachmentProps{ CoreNetworkId: jsii.String("coreNetworkId"), SubnetArns: []*string{ jsii.String("subnetArns"), }, VpcArn: jsii.String("vpcArn"), // the properties below are optional Options: &VpcOptionsProperty{ ApplianceModeSupport: jsii.Boolean(false), Ipv6Support: jsii.Boolean(false), }, ProposedSegmentChange: &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, Tags: []*cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnVpcAttachment_ProposedSegmentChangeProperty ¶ added in v2.55.0
type CfnVpcAttachment_ProposedSegmentChangeProperty struct { // The rule number in the policy document that applies to this change. AttachmentPolicyRuleNumber *float64 `field:"optional" json:"attachmentPolicyRuleNumber" yaml:"attachmentPolicyRuleNumber"` // The name of the segment to change. SegmentName *string `field:"optional" json:"segmentName" yaml:"segmentName"` // The list of key-value tags that changed for the segment. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Describes a proposed segment change.
In some cases, the segment change must first be evaluated and accepted.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" proposedSegmentChangeProperty := &ProposedSegmentChangeProperty{ AttachmentPolicyRuleNumber: jsii.Number(123), SegmentName: jsii.String("segmentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnVpcAttachment_VpcOptionsProperty ¶ added in v2.25.0
type CfnVpcAttachment_VpcOptionsProperty struct { // 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` . ApplianceModeSupport interface{} `field:"optional" json:"applianceModeSupport" yaml:"applianceModeSupport"` // Indicates whether IPv6 is supported. Ipv6Support interface{} `field:"optional" json:"ipv6Support" yaml:"ipv6Support"` }
Describes the VPC options.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcOptionsProperty := &VpcOptionsProperty{ ApplianceModeSupport: jsii.Boolean(false), Ipv6Support: jsii.Boolean(false), }
Source Files ¶
- CfnConnectAttachment.go
- CfnConnectAttachmentProps.go
- CfnConnectAttachment_ConnectAttachmentOptionsProperty.go
- CfnConnectAttachment_ProposedSegmentChangeProperty.go
- CfnConnectAttachment__checks.go
- CfnConnectPeer.go
- CfnConnectPeerProps.go
- CfnConnectPeer_BgpOptionsProperty.go
- CfnConnectPeer_ConnectPeerBgpConfigurationProperty.go
- CfnConnectPeer_ConnectPeerConfigurationProperty.go
- CfnConnectPeer__checks.go
- CfnCoreNetwork.go
- CfnCoreNetworkProps.go
- CfnCoreNetwork_CoreNetworkEdgeProperty.go
- CfnCoreNetwork_CoreNetworkSegmentProperty.go
- CfnCoreNetwork__checks.go
- CfnCustomerGatewayAssociation.go
- CfnCustomerGatewayAssociationProps.go
- CfnCustomerGatewayAssociation__checks.go
- CfnDevice.go
- CfnDeviceProps.go
- CfnDevice_LocationProperty.go
- CfnDevice__checks.go
- CfnGlobalNetwork.go
- CfnGlobalNetworkProps.go
- CfnGlobalNetwork__checks.go
- CfnLink.go
- CfnLinkAssociation.go
- CfnLinkAssociationProps.go
- CfnLinkAssociation__checks.go
- CfnLinkProps.go
- CfnLink_BandwidthProperty.go
- CfnLink__checks.go
- CfnSite.go
- CfnSiteProps.go
- CfnSiteToSiteVpnAttachment.go
- CfnSiteToSiteVpnAttachmentProps.go
- CfnSiteToSiteVpnAttachment_ProposedSegmentChangeProperty.go
- CfnSiteToSiteVpnAttachment__checks.go
- CfnSite_LocationProperty.go
- CfnSite__checks.go
- CfnTransitGatewayPeering.go
- CfnTransitGatewayPeeringProps.go
- CfnTransitGatewayPeering__checks.go
- CfnTransitGatewayRegistration.go
- CfnTransitGatewayRegistrationProps.go
- CfnTransitGatewayRegistration__checks.go
- CfnTransitGatewayRouteTableAttachment.go
- CfnTransitGatewayRouteTableAttachmentProps.go
- CfnTransitGatewayRouteTableAttachment_ProposedSegmentChangeProperty.go
- CfnTransitGatewayRouteTableAttachment__checks.go
- CfnVpcAttachment.go
- CfnVpcAttachmentProps.go
- CfnVpcAttachment_ProposedSegmentChangeProperty.go
- CfnVpcAttachment_VpcOptionsProperty.go
- CfnVpcAttachment__checks.go
- main.go