Package software.amazon.awscdk.services.appconfig

Class CfnExtensionAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appconfig.CfnExtensionAssociation
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:29:55.484Z") @Stability(Stable) public class CfnExtensionAssociation extends CfnResource implements IInspectable
A CloudFormation AWS::AppConfig::ExtensionAssociation.

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 Working with AWS AppConfig extensions 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();

  • 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 Construct scope, @NotNull String id, @Nullable CfnExtensionAssociationProps props)
      Create a new AWS::AppConfig::ExtensionAssociation.

      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.

    • CfnExtensionAssociation

      @Stability(Stable) public CfnExtensionAssociation(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::AppConfig::ExtensionAssociation.

      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 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Adds one or more tags for the specified extension association.

      Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

    • 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.

      If not specified, AWS AppConfig uses the maximum version of the extension.

    • setExtensionVersionNumber

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

      If not specified, AWS AppConfig uses the maximum version of the extension.

    • getParameters

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

      Extension parameters marked Required must be entered for this field.

    • setParameters

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

      Extension parameters marked Required must be entered for this field.

    • setParameters

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

      Extension parameters marked Required must be entered for this field.

    • 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.