Package software.amazon.awscdk.services.glue

Class CfnIntegrationResourceProperty

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.glue.CfnIntegrationResourceProperty
All Implemented Interfaces:
IInspectable, IIntegrationResourcePropertyRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:11.130Z") @Stability(Stable) public class CfnIntegrationResourceProperty extends CfnResource implements IInspectable, IIntegrationResourcePropertyRef, ITaggableV2
The AWS::Glue::IntegrationResourceProperty resource type can be used to setup ResourceProperty of the AWS Glue connection (for the SaaS source), DynamoDB Database (for DynamoDB source), or AWS Glue database ARN (for the target).

ResourceProperty is used to define the properties requires to setup the integration, including the role to access the connection or database, KMS keys, event bus for event notifications and VPC connection. To set both source and target properties the same API needs to be invoked twice, once with the AWS Glue connection ARN as ResourceArn with SourceProcessingProperties and next, with the AWS Glue database ARN as ResourceArn with TargetProcessingProperties respectively.

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.glue.*;
 CfnIntegrationResourceProperty cfnIntegrationResourceProperty = CfnIntegrationResourceProperty.Builder.create(this, "MyCfnIntegrationResourceProperty")
         .resourceArn("resourceArn")
         // the properties below are optional
         .sourceProcessingProperties(SourceProcessingPropertiesProperty.builder()
                 .roleArn("roleArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetProcessingProperties(TargetProcessingPropertiesProperty.builder()
                 .roleArn("roleArn")
                 // the properties below are optional
                 .connectionName("connectionName")
                 .eventBusArn("eventBusArn")
                 .kmsArn("kmsArn")
                 .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

    • CfnIntegrationResourceProperty

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

    • CfnIntegrationResourceProperty

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

    • CfnIntegrationResourceProperty

      @Stability(Stable) public CfnIntegrationResourceProperty(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIntegrationResourcePropertyProps props)
      Create a new AWS::Glue::IntegrationResourceProperty.

      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. This parameter is required.

  • Method Details

    • isCfnIntegrationResourceProperty

      @Stability(Stable) @NotNull public static Boolean isCfnIntegrationResourceProperty(@NotNull Object x)
      Checks whether the given object is a CfnIntegrationResourceProperty.

      Parameters:
      x - 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.

    • getAttrResourcePropertyArn

      @Stability(Stable) @NotNull public String getAttrResourcePropertyArn()
      The integration resource property ARN.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getIntegrationResourcePropertyRef

      @Stability(Stable) @NotNull public IntegrationResourcePropertyReference getIntegrationResourcePropertyRef()
      A reference to a IntegrationResourceProperty resource.
      Specified by:
      getIntegrationResourcePropertyRef in interface IIntegrationResourcePropertyRef

    • getResourceArn

      @Stability(Stable) @NotNull public String getResourceArn()
      The connection ARN of the source, or the database ARN of the target.

    • setResourceArn

      @Stability(Stable) public void setResourceArn(@NotNull String value)
      The connection ARN of the source, or the database ARN of the target.

    • getSourceProcessingProperties

      @Stability(Stable) @Nullable public Object getSourceProcessingProperties()
      The resource properties associated with the integration source.

      Returns union: either IResolvable or CfnIntegrationResourceProperty.SourceProcessingPropertiesProperty

    • setSourceProcessingProperties

      @Stability(Stable) public void setSourceProcessingProperties(@Nullable IResolvable value)
      The resource properties associated with the integration source.

    • setSourceProcessingProperties

      @Stability(Stable) public void setSourceProcessingProperties(@Nullable CfnIntegrationResourceProperty.SourceProcessingPropertiesProperty value)
      The resource properties associated with the integration source.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getTargetProcessingProperties

      @Stability(Stable) @Nullable public Object getTargetProcessingProperties()
      The structure used to define the resource properties associated with the integration target.

      Returns union: either IResolvable or CfnIntegrationResourceProperty.TargetProcessingPropertiesProperty

    • setTargetProcessingProperties

      @Stability(Stable) public void setTargetProcessingProperties(@Nullable IResolvable value)
      The structure used to define the resource properties associated with the integration target.

    • setTargetProcessingProperties

      @Stability(Stable) public void setTargetProcessingProperties(@Nullable CfnIntegrationResourceProperty.TargetProcessingPropertiesProperty value)
      The structure used to define the resource properties associated with the integration target.