Package software.amazon.awscdk.services.appconfig

Class CfnExtensionAssociation

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.appconfig.CfnExtensionAssociation
All Implemented Interfaces:
IInspectable, ITaggable, IExtensionAssociationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:04.499Z") @Stability(Stable) public class CfnExtensionAssociation extends CfnResource implements IInspectable, IExtensionAssociationRef, ITaggable
When you create an extension or configure an AWS authored extension, you associate the extension with an AWS AppConfig application, environment, or configuration profile.

For example, you can choose to run the AWS AppConfig deployment events to Amazon SNS AWS authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AWS AppConfig resource is called an extension association . An extension association is a specified relationship between an extension and an AWS AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AWS AppConfig User Guide .

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.appconfig.*;
 CfnExtensionAssociation cfnExtensionAssociation = CfnExtensionAssociation.Builder.create(this, "MyCfnExtensionAssociation")
         .extensionIdentifier("extensionIdentifier")
         .extensionVersionNumber(123)
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .resourceIdentifier("resourceIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnExtensionAssociation

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

    • CfnExtensionAssociation

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

    • CfnExtensionAssociation

      @Stability(Stable) public CfnExtensionAssociation(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnExtensionAssociationProps 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.

    • CfnExtensionAssociation

      @Stability(Stable) public CfnExtensionAssociation(@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

    • fromExtensionAssociationArn

      @Stability(Stable) @NotNull public static IExtensionAssociationRef fromExtensionAssociationArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IExtensionAssociationRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromExtensionAssociationId

      @Stability(Stable) @NotNull public static IExtensionAssociationRef fromExtensionAssociationId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String extensionAssociationId)
      Creates a new IExtensionAssociationRef from a extensionAssociationId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      extensionAssociationId - This parameter is required.

    • 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 ARN of the extension defined in the association.

    • getAttrExtensionArn

      @Stability(Stable) @NotNull public String getAttrExtensionArn()
      The ARN of the extension defined in the association.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The system-generated ID for the association.

    • getAttrResourceArn

      @Stability(Stable) @NotNull public String getAttrResourceArn()
      The ARNs of applications, configuration profiles, or environments defined in the association.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getExtensionAssociationRef

      @Stability(Stable) @NotNull public ExtensionAssociationReference getExtensionAssociationRef()
      A reference to a ExtensionAssociation resource.
      Specified by:
      getExtensionAssociationRef in interface IExtensionAssociationRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getExtensionIdentifier

      @Stability(Stable) @Nullable public String getExtensionIdentifier()
      The name, the ID, or the Amazon Resource Name (ARN) of the extension.

    • setExtensionIdentifier

      @Stability(Stable) public void setExtensionIdentifier(@Nullable String value)
      The name, the ID, or the Amazon Resource Name (ARN) of the extension.

    • getExtensionVersionNumber

      @Stability(Stable) @Nullable public Number getExtensionVersionNumber()
      The version number of the extension.

    • setExtensionVersionNumber

      @Stability(Stable) public void setExtensionVersionNumber(@Nullable Number value)
      The version number of the extension.

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      The parameter names and values defined in the extensions.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable Map<String,String> value)
      The parameter names and values defined in the extensions.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable IResolvable value)
      The parameter names and values defined in the extensions.

    • getResourceIdentifier

      @Stability(Stable) @Nullable public String getResourceIdentifier()
      The ARN of an application, configuration profile, or environment.

    • setResourceIdentifier

      @Stability(Stable) public void setResourceIdentifier(@Nullable String value)
      The ARN of an application, configuration profile, or environment.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Adds one or more tags for the specified extension association.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Adds one or more tags for the specified extension association.