io.github.cdklabs.awscdk.appsync.utils.SourceApiAssociationMergeOperation Maven / Gradle / Ivy
Show all versions of awscdk-appsync-utils Show documentation
package io.github.cdklabs.awscdk.appsync.utils;
/**
* The SourceApiAssociationMergeOperation triggers a merge of a source API during a Cloudformation stack update.
*
* This can be used to propagate changes from the source API to the Merged API when the association is using type MANUAL_MERGE.
* If the merge operation fails, it will fail the Cloudformation update and rollback the stack.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-28T00:18:00.322Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.awscdk.appsync.utils.$Module.class, fqn = "awscdk-appsync-utils.SourceApiAssociationMergeOperation")
public class SourceApiAssociationMergeOperation extends software.constructs.Construct {
protected SourceApiAssociationMergeOperation(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected SourceApiAssociationMergeOperation(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public SourceApiAssociationMergeOperation(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull io.github.cdklabs.awscdk.appsync.utils.SourceApiAssociationMergeOperationProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* A fluent builder for {@link io.github.cdklabs.awscdk.appsync.utils.SourceApiAssociationMergeOperation}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
return new Builder(scope, id);
}
private final software.constructs.Construct scope;
private final java.lang.String id;
private final io.github.cdklabs.awscdk.appsync.utils.SourceApiAssociationMergeOperationProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new io.github.cdklabs.awscdk.appsync.utils.SourceApiAssociationMergeOperationProps.Builder();
}
/**
* The source api association resource which will be merged.
*
* @return {@code this}
* @param sourceApiAssociation The source api association resource which will be merged. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder sourceApiAssociation(final software.amazon.awscdk.services.appsync.ISourceApiAssociation sourceApiAssociation) {
this.props.sourceApiAssociation(sourceApiAssociation);
return this;
}
/**
* Flag indicating whether the source api should be merged on every CFN update or not.
*
* If set to true and there are no changes to the source API, this will result in a no-op merge operation.
*
* Default: False
*
* @return {@code this}
* @param alwaysMergeOnStackUpdate Flag indicating whether the source api should be merged on every CFN update or not. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder alwaysMergeOnStackUpdate(final java.lang.Boolean alwaysMergeOnStackUpdate) {
this.props.alwaysMergeOnStackUpdate(alwaysMergeOnStackUpdate);
return this;
}
/**
* The merge operation provider construct which is responsible for configuring the Lambda resource that will be invoked during Cloudformation update.
*
* @return {@code this}
* @param mergeOperationProvider The merge operation provider construct which is responsible for configuring the Lambda resource that will be invoked during Cloudformation update. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder mergeOperationProvider(final io.github.cdklabs.awscdk.appsync.utils.ISourceApiAssociationMergeOperationProvider mergeOperationProvider) {
this.props.mergeOperationProvider(mergeOperationProvider);
return this;
}
/**
* The version identifier for the schema merge operation.
*
* Any change to the version identifier will trigger a merge on the next
* update. Use the version identifier property to control when the source API metadata is merged.
*
* Default: null
*
* @return {@code this}
* @param versionIdentifier The version identifier for the schema merge operation. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder versionIdentifier(final java.lang.String versionIdentifier) {
this.props.versionIdentifier(versionIdentifier);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.awscdk.appsync.utils.SourceApiAssociationMergeOperation}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public io.github.cdklabs.awscdk.appsync.utils.SourceApiAssociationMergeOperation build() {
return new io.github.cdklabs.awscdk.appsync.utils.SourceApiAssociationMergeOperation(
this.scope,
this.id,
this.props.build()
);
}
}
}