Class CfnServiceNetworkServiceAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.007Z") @Stability(Stable) public class CfnServiceNetworkServiceAssociation extends CfnResource implements IInspectable
A CloudFormation AWS::VpcLattice::ServiceNetworkServiceAssociation.

Associates a service with a service network.

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();
 
  • 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 Construct scope, @NotNull String id, @Nullable CfnServiceNetworkServiceAssociationProps props)
      Create a new AWS::VpcLattice::ServiceNetworkServiceAssociation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
    • CfnServiceNetworkServiceAssociation

      @Stability(Stable) public CfnServiceNetworkServiceAssociation(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::VpcLattice::ServiceNetworkServiceAssociation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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()
      The tags for the association.
    • getDnsEntry

      @Stability(Stable) @Nullable public Object getDnsEntry()
      AWS::VpcLattice::ServiceNetworkServiceAssociation.DnsEntry.
    • setDnsEntry

      @Stability(Stable) public void setDnsEntry(@Nullable IResolvable value)
      AWS::VpcLattice::ServiceNetworkServiceAssociation.DnsEntry.
    • setDnsEntry

      @Stability(Stable) public void setDnsEntry(@Nullable CfnServiceNetworkServiceAssociation.DnsEntryProperty value)
      AWS::VpcLattice::ServiceNetworkServiceAssociation.DnsEntry.
    • 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.

      You must use the ARN if the resources specified in the operation are in different accounts.

    • setServiceNetworkIdentifier

      @Stability(Stable) public void setServiceNetworkIdentifier(@Nullable String value)
      The ID or Amazon Resource Name (ARN) of the service network.

      You must use the ARN if the resources specified in the operation are in different accounts.