Package software.amazon.awscdk.services.vpclattice

Class CfnServiceNetworkServiceAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.vpclattice.CfnServiceNetworkServiceAssociation

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.816Z")
@Stability(Stable)
public class CfnServiceNetworkServiceAssociation
extends CfnResource
implements IInspectable, ITaggable

Associates a service with a service network.

For more information, see Manage service associations in the Amazon VPC Lattice User Guide .

You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it.

You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network.

As a result of this operation, the association is created in the service network account and the association owner account.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.vpclattice.*;
 CfnServiceNetworkServiceAssociation cfnServiceNetworkServiceAssociation = CfnServiceNetworkServiceAssociation.Builder.create(this, "MyCfnServiceNetworkServiceAssociation")
         .dnsEntry(DnsEntryProperty.builder()
                 .domainName("domainName")
                 .hostedZoneId("hostedZoneId")
                 .build())
         .serviceIdentifier("serviceIdentifier")
         .serviceNetworkIdentifier("serviceNetworkIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnServiceNetworkServiceAssociation.Builder	A fluent builder for CfnServiceNetworkServiceAssociation.
static interface	CfnServiceNetworkServiceAssociation.DnsEntryProperty	The DNS information.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnServiceNetworkServiceAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnServiceNetworkServiceAssociation(software.amazon.jsii.JsiiObjectRef objRef)
	CfnServiceNetworkServiceAssociation(software.constructs.Construct scope, String id)
	CfnServiceNetworkServiceAssociation(software.constructs.Construct scope, String id, CfnServiceNetworkServiceAssociationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the association between the service network and the service.
String	getAttrCreatedAt()	The date and time that the association was created, specified in ISO-8601 format.
String	getAttrDnsEntryDomainName()	The domain name of the service.
String	getAttrDnsEntryHostedZoneId()	The ID of the hosted zone.
String	getAttrId()	The ID of the of the association between the service network and the service.
String	getAttrServiceArn()	The Amazon Resource Name (ARN) of the service.
String	getAttrServiceId()	The ID of the service.
String	getAttrServiceName()	The name of the service.
String	getAttrServiceNetworkArn()	The Amazon Resource Name (ARN) of the service network.
String	getAttrServiceNetworkId()	The ID of the service network.
String	getAttrServiceNetworkName()	The name of the service network.
String	getAttrStatus()	The status of the association between the service network and the service.
protected Map<String,Object>	getCfnProperties()
Object	getDnsEntry()	The DNS information of the service.
String	getServiceIdentifier()	The ID or Amazon Resource Name (ARN) of the service.
String	getServiceNetworkIdentifier()	The ID or Amazon Resource Name (ARN) of the service network.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags for the association.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDnsEntry(IResolvable value)	The DNS information of the service.
void	setDnsEntry(CfnServiceNetworkServiceAssociation.DnsEntryProperty value)	The DNS information of the service.
void	setServiceIdentifier(String value)	The ID or Amazon Resource Name (ARN) of the service.
void	setServiceNetworkIdentifier(String value)	The ID or Amazon Resource Name (ARN) of the service network.
void	setTagsRaw(List<CfnTag> value)	The tags for the association.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnServiceNetworkServiceAssociation

protected CfnServiceNetworkServiceAssociation(software.amazon.jsii.JsiiObjectRef objRef)

CfnServiceNetworkServiceAssociation

protected CfnServiceNetworkServiceAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnServiceNetworkServiceAssociation

@Stability(Stable)
public CfnServiceNetworkServiceAssociation(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnServiceNetworkServiceAssociationProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnServiceNetworkServiceAssociation

@Stability(Stable)
public CfnServiceNetworkServiceAssociation(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the association between the service network and the service.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The date and time that the association was created, specified in ISO-8601 format.

getAttrDnsEntryDomainName

@Stability(Stable)
@NotNull
public String getAttrDnsEntryDomainName()

The domain name of the service.

getAttrDnsEntryHostedZoneId

@Stability(Stable)
@NotNull
public String getAttrDnsEntryHostedZoneId()

The ID of the hosted zone.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The ID of the of the association between the service network and the service.

getAttrServiceArn

@Stability(Stable)
@NotNull
public String getAttrServiceArn()

The Amazon Resource Name (ARN) of the service.

getAttrServiceId

@Stability(Stable)
@NotNull
public String getAttrServiceId()

The ID of the service.

getAttrServiceName

@Stability(Stable)
@NotNull
public String getAttrServiceName()

The name of the service.

getAttrServiceNetworkArn

@Stability(Stable)
@NotNull
public String getAttrServiceNetworkArn()

The Amazon Resource Name (ARN) of the service network.

getAttrServiceNetworkId

@Stability(Stable)
@NotNull
public String getAttrServiceNetworkId()

The ID of the service network.

getAttrServiceNetworkName

@Stability(Stable)
@NotNull
public String getAttrServiceNetworkName()

The name of the service network.

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The status of the association between the service network and the service.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getDnsEntry

@Stability(Stable)
@Nullable
public Object getDnsEntry()

The DNS information of the service.

setDnsEntry

@Stability(Stable)
public void setDnsEntry(@Nullable
 IResolvable value)

The DNS information of the service.

setDnsEntry

@Stability(Stable)
public void setDnsEntry(@Nullable
 CfnServiceNetworkServiceAssociation.DnsEntryProperty value)

The DNS information of the service.

getServiceIdentifier

@Stability(Stable)
@Nullable
public String getServiceIdentifier()

The ID or Amazon Resource Name (ARN) of the service.

setServiceIdentifier

@Stability(Stable)
public void setServiceIdentifier(@Nullable
 String value)

The ID or Amazon Resource Name (ARN) of the service.

getServiceNetworkIdentifier

@Stability(Stable)
@Nullable
public String getServiceNetworkIdentifier()

The ID or Amazon Resource Name (ARN) of the service network.

setServiceNetworkIdentifier

@Stability(Stable)
public void setServiceNetworkIdentifier(@Nullable
 String value)

The ID or Amazon Resource Name (ARN) of the service network.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The tags for the association.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The tags for the association.