io.github.jogold.cloudstructs.SlackApp Maven / Gradle / Ivy
Show all versions of cloudstructs Show documentation
package io.github.jogold.cloudstructs;
/**
* A Slack application deployed with a manifest.
*
* @see https://api.slack.com/reference/manifests
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.106.0 (build e852934)", date = "2024-12-26T12:04:08.055Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = io.github.jogold.cloudstructs.$Module.class, fqn = "cloudstructs.SlackApp")
public class SlackApp extends software.constructs.Construct {
protected SlackApp(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected SlackApp(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 SlackApp(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.jogold.cloudstructs.SlackAppProps 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") });
}
/**
* The ID of the application.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAppId() {
return software.amazon.jsii.Kernel.get(this, "appId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* A dynamic reference to the client ID of the app.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getClientId() {
return software.amazon.jsii.Kernel.get(this, "clientId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* A dynamic reference to the client secret of the app.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getClientSecret() {
return software.amazon.jsii.Kernel.get(this, "clientSecret", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* An AWS Secrets Manager secret containing the credentials of the application.
*
*
* {
* "appId": "...",
* "clientId": "...",
* "clientSecret": "...",
* "verificationToken": "...",
* "signingSecret": "..."
* }
*
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.secretsmanager.ISecret getCredentials() {
return software.amazon.jsii.Kernel.get(this, "credentials", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.secretsmanager.ISecret.class));
}
/**
* A dynamic reference to the signing secret of the app.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getSigningSecret() {
return software.amazon.jsii.Kernel.get(this, "signingSecret", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* A dynamic reference to the verification token of the app.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getVerificationToken() {
return software.amazon.jsii.Kernel.get(this, "verificationToken", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* A fluent builder for {@link io.github.jogold.cloudstructs.SlackApp}.
*/
@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.jogold.cloudstructs.SlackAppProps.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.jogold.cloudstructs.SlackAppProps.Builder();
}
/**
* An AWS Secrets Manager secret containing the app configuration token.
*
* Must use the following JSON format:
*
*
* {
* "refreshToken": "<token>"
* }
*
*
* @return {@code this}
* @param configurationTokenSecret An AWS Secrets Manager secret containing the app configuration token. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder configurationTokenSecret(final software.amazon.awscdk.services.secretsmanager.ISecret configurationTokenSecret) {
this.props.configurationTokenSecret(configurationTokenSecret);
return this;
}
/**
* The definition of the app manifest.
*
* @return {@code this}
* @see https://api.slack.com/reference/manifests
* @param manifest The definition of the app manifest. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder manifest(final io.github.jogold.cloudstructs.SlackAppManifestDefinition manifest) {
this.props.manifest(manifest);
return this;
}
/**
* The AWS Secrets Manager secret where to store the app credentials.
*
* Default: - a new secret is created
*
* @return {@code this}
* @param credentialsSecret The AWS Secrets Manager secret where to store the app credentials. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder credentialsSecret(final software.amazon.awscdk.services.secretsmanager.ISecret credentialsSecret) {
this.props.credentialsSecret(credentialsSecret);
return this;
}
/**
* @return a newly built instance of {@link io.github.jogold.cloudstructs.SlackApp}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public io.github.jogold.cloudstructs.SlackApp build() {
return new io.github.jogold.cloudstructs.SlackApp(
this.scope,
this.id,
this.props.build()
);
}
}
}