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 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 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 awscdk.Construct, id *string, ...)
- func NewCfnConnectPeer_Override(c CfnConnectPeer, scope awscdk.Construct, id *string, ...)
- func NewCfnCoreNetwork_Override(c CfnCoreNetwork, scope awscdk.Construct, id *string, ...)
- func NewCfnCustomerGatewayAssociation_Override(c CfnCustomerGatewayAssociation, scope awscdk.Construct, id *string, ...)
- func NewCfnDevice_Override(c CfnDevice, scope awscdk.Construct, id *string, props *CfnDeviceProps)
- func NewCfnGlobalNetwork_Override(c CfnGlobalNetwork, scope awscdk.Construct, id *string, ...)
- func NewCfnLinkAssociation_Override(c CfnLinkAssociation, scope awscdk.Construct, id *string, ...)
- func NewCfnLink_Override(c CfnLink, scope awscdk.Construct, id *string, props *CfnLinkProps)
- func NewCfnSiteToSiteVpnAttachment_Override(c CfnSiteToSiteVpnAttachment, scope awscdk.Construct, id *string, ...)
- func NewCfnSite_Override(c CfnSite, scope awscdk.Construct, id *string, props *CfnSiteProps)
- func NewCfnTransitGatewayRegistration_Override(c CfnTransitGatewayRegistration, scope awscdk.Construct, id *string, ...)
- func NewCfnVpcAttachment_Override(c CfnVpcAttachment, scope awscdk.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 CfnTransitGatewayRegistration
- type CfnTransitGatewayRegistrationProps
- 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 ¶
func CfnConnectAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnConnectAttachment_IsCfnElement ¶
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. Experimental.
func CfnConnectAttachment_IsCfnResource ¶
func CfnConnectAttachment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnConnectAttachment_IsConstruct ¶
func CfnConnectAttachment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnConnectPeer_CFN_RESOURCE_TYPE_NAME ¶
func CfnConnectPeer_CFN_RESOURCE_TYPE_NAME() *string
func CfnConnectPeer_IsCfnElement ¶
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. Experimental.
func CfnConnectPeer_IsCfnResource ¶
func CfnConnectPeer_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnConnectPeer_IsConstruct ¶
func CfnConnectPeer_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnCoreNetwork_CFN_RESOURCE_TYPE_NAME ¶
func CfnCoreNetwork_CFN_RESOURCE_TYPE_NAME() *string
func CfnCoreNetwork_IsCfnElement ¶
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. Experimental.
func CfnCoreNetwork_IsCfnResource ¶
func CfnCoreNetwork_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnCoreNetwork_IsConstruct ¶
func CfnCoreNetwork_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnCustomerGatewayAssociation_IsCfnResource ¶
func CfnCustomerGatewayAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnCustomerGatewayAssociation_IsConstruct ¶
func CfnCustomerGatewayAssociation_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnDevice_IsCfnResource ¶
func CfnDevice_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDevice_IsConstruct ¶
func CfnDevice_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnGlobalNetwork_IsCfnResource ¶
func CfnGlobalNetwork_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnGlobalNetwork_IsConstruct ¶
func CfnGlobalNetwork_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnLinkAssociation_IsCfnResource ¶
func CfnLinkAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnLinkAssociation_IsConstruct ¶
func CfnLinkAssociation_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnLink_IsCfnResource ¶
func CfnLink_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnLink_IsConstruct ¶
func CfnLink_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnSiteToSiteVpnAttachment_CFN_RESOURCE_TYPE_NAME ¶
func CfnSiteToSiteVpnAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnSiteToSiteVpnAttachment_IsCfnElement ¶
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. Experimental.
func CfnSiteToSiteVpnAttachment_IsCfnResource ¶
func CfnSiteToSiteVpnAttachment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSiteToSiteVpnAttachment_IsConstruct ¶
func CfnSiteToSiteVpnAttachment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnSite_IsCfnResource ¶
func CfnSite_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSite_IsConstruct ¶
func CfnSite_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnTransitGatewayRegistration_IsCfnResource ¶
func CfnTransitGatewayRegistration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnTransitGatewayRegistration_IsConstruct ¶
func CfnTransitGatewayRegistration_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnVpcAttachment_CFN_RESOURCE_TYPE_NAME ¶
func CfnVpcAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnVpcAttachment_IsCfnElement ¶
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. Experimental.
func CfnVpcAttachment_IsCfnResource ¶
func CfnVpcAttachment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnVpcAttachment_IsConstruct ¶
func CfnVpcAttachment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnConnectAttachment_Override ¶
func NewCfnConnectAttachment_Override(c CfnConnectAttachment, scope awscdk.Construct, id *string, props *CfnConnectAttachmentProps)
Create a new `AWS::NetworkManager::ConnectAttachment`.
func NewCfnConnectPeer_Override ¶
func NewCfnConnectPeer_Override(c CfnConnectPeer, scope awscdk.Construct, id *string, props *CfnConnectPeerProps)
Create a new `AWS::NetworkManager::ConnectPeer`.
func NewCfnCoreNetwork_Override ¶
func NewCfnCoreNetwork_Override(c CfnCoreNetwork, scope awscdk.Construct, id *string, props *CfnCoreNetworkProps)
Create a new `AWS::NetworkManager::CoreNetwork`.
func NewCfnCustomerGatewayAssociation_Override ¶
func NewCfnCustomerGatewayAssociation_Override(c CfnCustomerGatewayAssociation, scope awscdk.Construct, id *string, props *CfnCustomerGatewayAssociationProps)
Create a new `AWS::NetworkManager::CustomerGatewayAssociation`.
func NewCfnDevice_Override ¶
func NewCfnDevice_Override(c CfnDevice, scope awscdk.Construct, id *string, props *CfnDeviceProps)
Create a new `AWS::NetworkManager::Device`.
func NewCfnGlobalNetwork_Override ¶
func NewCfnGlobalNetwork_Override(c CfnGlobalNetwork, scope awscdk.Construct, id *string, props *CfnGlobalNetworkProps)
Create a new `AWS::NetworkManager::GlobalNetwork`.
func NewCfnLinkAssociation_Override ¶
func NewCfnLinkAssociation_Override(c CfnLinkAssociation, scope awscdk.Construct, id *string, props *CfnLinkAssociationProps)
Create a new `AWS::NetworkManager::LinkAssociation`.
func NewCfnLink_Override ¶
func NewCfnLink_Override(c CfnLink, scope awscdk.Construct, id *string, props *CfnLinkProps)
Create a new `AWS::NetworkManager::Link`.
func NewCfnSiteToSiteVpnAttachment_Override ¶
func NewCfnSiteToSiteVpnAttachment_Override(c CfnSiteToSiteVpnAttachment, scope awscdk.Construct, id *string, props *CfnSiteToSiteVpnAttachmentProps)
Create a new `AWS::NetworkManager::SiteToSiteVpnAttachment`.
func NewCfnSite_Override ¶
func NewCfnSite_Override(c CfnSite, scope awscdk.Construct, id *string, props *CfnSiteProps)
Create a new `AWS::NetworkManager::Site`.
func NewCfnTransitGatewayRegistration_Override ¶
func NewCfnTransitGatewayRegistration_Override(c CfnTransitGatewayRegistration, scope awscdk.Construct, id *string, props *CfnTransitGatewayRegistrationProps)
Create a new `AWS::NetworkManager::TransitGatewayRegistration`.
func NewCfnVpcAttachment_Override ¶
func NewCfnVpcAttachment_Override(c CfnVpcAttachment, scope awscdk.Construct, id *string, props *CfnVpcAttachmentProps)
Create a new `AWS::NetworkManager::VpcAttachment`.
Types ¶
type CfnConnectAttachment ¶
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
AttrProposedSegmentChangeAttachmentPolicyRuleNumber() *float64
AttrProposedSegmentChangeSegmentName() *string
AttrProposedSegmentChangeTags() awscdk.IResolvable
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Options for creating a Connect attachment.
Options() interface{}
SetOptions(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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags associated with the Connect attachment.
Tags() awscdk.TagManager
// The ID of the attachment between the two connections.
TransportAttachmentId() *string
SetTransportAttachmentId(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnConnectAttachment ¶
func NewCfnConnectAttachment(scope awscdk.Construct, id *string, props *CfnConnectAttachmentProps) CfnConnectAttachment
Create a new `AWS::NetworkManager::ConnectAttachment`.
type CfnConnectAttachmentProps ¶
type CfnConnectAttachmentProps struct {
// The core network ID.
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 creating a Connect attachment.
Options interface{} `field:"required" json:"options" yaml:"options"`
// The ID of the attachment between the two connections.
TransportAttachmentId *string `field:"required" json:"transportAttachmentId" yaml:"transportAttachmentId"`
// The tags associated with the Connect attachment.
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
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnConnectAttachment_ConnectAttachmentOptionsProperty ¶
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 ¶
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 ¶
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
// The BGP peer options.
BgpOptions() interface{}
SetBgpOptions(val interface{})
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// The ID of Connect peer.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The list of key-value tags associated with the Connect peer.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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{
bgpOptions: &bgpOptionsProperty{
peerAsn: jsii.Number(123),
},
connectAttachmentId: jsii.String("connectAttachmentId"),
coreNetworkAddress: jsii.String("coreNetworkAddress"),
insideCidrBlocks: []*string{
jsii.String("insideCidrBlocks"),
},
peerAddress: jsii.String("peerAddress"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnConnectPeer ¶
func NewCfnConnectPeer(scope awscdk.Construct, id *string, props *CfnConnectPeerProps) CfnConnectPeer
Create a new `AWS::NetworkManager::ConnectPeer`.
type CfnConnectPeerProps ¶
type CfnConnectPeerProps struct {
// The BGP peer options.
BgpOptions interface{} `field:"optional" json:"bgpOptions" yaml:"bgpOptions"`
// The ID of Connect peer.
ConnectAttachmentId *string `field:"optional" json:"connectAttachmentId" yaml:"connectAttachmentId"`
// 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 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{
bgpOptions: &bgpOptionsProperty{
peerAsn: jsii.Number(123),
},
connectAttachmentId: jsii.String("connectAttachmentId"),
coreNetworkAddress: jsii.String("coreNetworkAddress"),
insideCidrBlocks: []*string{
jsii.String("insideCidrBlocks"),
},
peerAddress: jsii.String("peerAddress"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnConnectPeer_BgpOptionsProperty ¶
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 ¶
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 ¶
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 ¶
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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Describes a core network policy. For more information, see [Core network policies](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-policy-changesets.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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The list of key-value tags associated with a core network.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::NetworkManager::CoreNetwork`.
Describes a core network within 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"
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 ¶
func NewCfnCoreNetwork(scope awscdk.Construct, id *string, props *CfnCoreNetworkProps) CfnCoreNetwork
Create a new `AWS::NetworkManager::CoreNetwork`.
type CfnCoreNetworkProps ¶
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/vpc/latest/cloudwan/cloudwan-policy-changesets.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 ¶
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 ¶
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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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 awscdk.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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The model of the device.
//
// Constraints: Maximum length of 128 characters.
Model() *string
SetModel(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
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).
// Experimental.
Stack() awscdk.Stack
// The tags for the device.
Tags() awscdk.TagManager
// The device type.
Type() *string
SetType(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *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)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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 awscdk.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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags for the global network.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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 awscdk.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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
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).
// Experimental.
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)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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 awscdk.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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::NetworkManager::LinkAssociation`.
Specifies the association between a device and a link. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same 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"
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 awscdk.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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags for the site.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::NetworkManager::Site`.
Specifies a 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 awscdk.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 ¶
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
AttrProposedSegmentChangeAttachmentPolicyRuleNumber() *float64
AttrProposedSegmentChangeSegmentName() *string
AttrProposedSegmentChangeTags() awscdk.IResolvable
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags associated with the site-to-site VPN attachment.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// The ARN of the site-to-site VPN attachment.
VpnConnectionArn() *string
SetVpnConnectionArn(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
vpnConnectionArn: jsii.String("vpnConnectionArn"),
})
func NewCfnSiteToSiteVpnAttachment ¶
func NewCfnSiteToSiteVpnAttachment(scope awscdk.Construct, id *string, props *CfnSiteToSiteVpnAttachmentProps) CfnSiteToSiteVpnAttachment
Create a new `AWS::NetworkManager::SiteToSiteVpnAttachment`.
type CfnSiteToSiteVpnAttachmentProps ¶
type CfnSiteToSiteVpnAttachmentProps struct {
// The core network ID.
CoreNetworkId *string `field:"optional" json:"coreNetworkId" yaml:"coreNetworkId"`
// The tags associated with the site-to-site VPN attachment.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The ARN of the site-to-site VPN attachment.
VpnConnectionArn *string `field:"optional" json:"vpnConnectionArn" yaml:"vpnConnectionArn"`
}
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"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
vpnConnectionArn: jsii.String("vpnConnectionArn"),
}
type CfnSiteToSiteVpnAttachment_ProposedSegmentChangeProperty ¶
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 CfnTransitGatewayRegistration ¶
type CfnTransitGatewayRegistration interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The Amazon Resource Name (ARN) of the transit gateway.
TransitGatewayArn() *string
SetTransitGatewayArn(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::NetworkManager::TransitGatewayRegistration`.
Registers a transit gateway in your global network. The transit gateway can be in any AWS Region , 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 awscdk.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 CfnVpcAttachment ¶
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
AttrProposedSegmentChangeAttachmentPolicyRuleNumber() *float64
AttrProposedSegmentChangeSegmentName() *string
AttrProposedSegmentChangeTags() awscdk.IResolvable
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Options for creating the VPC attachment.
Options() interface{}
SetOptions(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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The subnet ARNs.
SubnetArns() *[]*string
SetSubnetArns(val *[]*string)
// The tags associated with the VPC attachment.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// The ARN of the VPC attachment.
VpcArn() *string
SetVpcArn(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnVpcAttachment ¶
func NewCfnVpcAttachment(scope awscdk.Construct, id *string, props *CfnVpcAttachmentProps) CfnVpcAttachment
Create a new `AWS::NetworkManager::VpcAttachment`.
type CfnVpcAttachmentProps ¶
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"`
// 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),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnVpcAttachment_ProposedSegmentChangeProperty ¶
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 ¶
type CfnVpcAttachment_VpcOptionsProperty struct {
// `CfnVpcAttachment.VpcOptionsProperty.ApplianceModeSupport`.
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
¶
- awsnetworkmanager.go
- awsnetworkmanager_CfnConnectAttachment.go
- awsnetworkmanager_CfnConnectAttachmentProps.go
- awsnetworkmanager_CfnConnectAttachment_ConnectAttachmentOptionsProperty.go
- awsnetworkmanager_CfnConnectAttachment_ProposedSegmentChangeProperty.go
- awsnetworkmanager_CfnConnectAttachment__runtime_type_checks.go
- awsnetworkmanager_CfnConnectPeer.go
- awsnetworkmanager_CfnConnectPeerProps.go
- awsnetworkmanager_CfnConnectPeer_BgpOptionsProperty.go
- awsnetworkmanager_CfnConnectPeer_ConnectPeerBgpConfigurationProperty.go
- awsnetworkmanager_CfnConnectPeer_ConnectPeerConfigurationProperty.go
- awsnetworkmanager_CfnConnectPeer__runtime_type_checks.go
- awsnetworkmanager_CfnCoreNetwork.go
- awsnetworkmanager_CfnCoreNetworkProps.go
- awsnetworkmanager_CfnCoreNetwork_CoreNetworkEdgeProperty.go
- awsnetworkmanager_CfnCoreNetwork_CoreNetworkSegmentProperty.go
- awsnetworkmanager_CfnCoreNetwork__runtime_type_checks.go
- awsnetworkmanager_CfnCustomerGatewayAssociation.go
- awsnetworkmanager_CfnCustomerGatewayAssociationProps.go
- awsnetworkmanager_CfnCustomerGatewayAssociation__runtime_type_checks.go
- awsnetworkmanager_CfnDevice.go
- awsnetworkmanager_CfnDeviceProps.go
- awsnetworkmanager_CfnDevice_LocationProperty.go
- awsnetworkmanager_CfnDevice__runtime_type_checks.go
- awsnetworkmanager_CfnGlobalNetwork.go
- awsnetworkmanager_CfnGlobalNetworkProps.go
- awsnetworkmanager_CfnGlobalNetwork__runtime_type_checks.go
- awsnetworkmanager_CfnLink.go
- awsnetworkmanager_CfnLinkAssociation.go
- awsnetworkmanager_CfnLinkAssociationProps.go
- awsnetworkmanager_CfnLinkAssociation__runtime_type_checks.go
- awsnetworkmanager_CfnLinkProps.go
- awsnetworkmanager_CfnLink_BandwidthProperty.go
- awsnetworkmanager_CfnLink__runtime_type_checks.go
- awsnetworkmanager_CfnSite.go
- awsnetworkmanager_CfnSiteProps.go
- awsnetworkmanager_CfnSiteToSiteVpnAttachment.go
- awsnetworkmanager_CfnSiteToSiteVpnAttachmentProps.go
- awsnetworkmanager_CfnSiteToSiteVpnAttachment_ProposedSegmentChangeProperty.go
- awsnetworkmanager_CfnSiteToSiteVpnAttachment__runtime_type_checks.go
- awsnetworkmanager_CfnSite_LocationProperty.go
- awsnetworkmanager_CfnSite__runtime_type_checks.go
- awsnetworkmanager_CfnTransitGatewayRegistration.go
- awsnetworkmanager_CfnTransitGatewayRegistrationProps.go
- awsnetworkmanager_CfnTransitGatewayRegistration__runtime_type_checks.go
- awsnetworkmanager_CfnVpcAttachment.go
- awsnetworkmanager_CfnVpcAttachmentProps.go
- awsnetworkmanager_CfnVpcAttachment_ProposedSegmentChangeProperty.go
- awsnetworkmanager_CfnVpcAttachment_VpcOptionsProperty.go
- awsnetworkmanager_CfnVpcAttachment__runtime_type_checks.go