software.amazon.awscdk.services.glue.alpha.SecurityConfiguration Maven / Gradle / Ivy
Show all versions of glue-alpha Show documentation
package software.amazon.awscdk.services.glue.alpha;
/**
* (experimental) A security configuration is a set of security properties that can be used by AWS Glue to encrypt data at rest.
*
* The following scenarios show some of the ways that you can use a security configuration.
*
*
* - Attach a security configuration to an AWS Glue crawler to write encrypted Amazon CloudWatch Logs.
* - Attach a security configuration to an extract, transform, and load (ETL) job to write encrypted Amazon Simple Storage Service (Amazon S3) targets and encrypted CloudWatch Logs.
* - Attach a security configuration to an ETL job to write its jobs bookmarks as encrypted Amazon S3 data.
* - Attach a security configuration to a development endpoint to write encrypted Amazon S3 targets.
*
*
* Example:
*
*
* SecurityConfiguration.Builder.create(this, "MySecurityConfiguration")
* .cloudWatchEncryption(CloudWatchEncryption.builder()
* .mode(CloudWatchEncryptionMode.KMS)
* .build())
* .jobBookmarksEncryption(JobBookmarksEncryption.builder()
* .mode(JobBookmarksEncryptionMode.CLIENT_SIDE_KMS)
* .build())
* .s3Encryption(S3Encryption.builder()
* .mode(S3EncryptionMode.KMS)
* .build())
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.99.0 (build 8f757e4)", date = "2024-06-13T18:49:27.692Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.glue.alpha.$Module.class, fqn = "@aws-cdk/aws-glue-alpha.SecurityConfiguration")
public class SecurityConfiguration extends software.amazon.awscdk.Resource implements software.amazon.awscdk.services.glue.alpha.ISecurityConfiguration {
protected SecurityConfiguration(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected SecurityConfiguration(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public SecurityConfiguration(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.glue.alpha.SecurityConfigurationProps 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"), props });
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public SecurityConfiguration(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id) {
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") });
}
/**
* (experimental) Creates a Connection construct that represents an external security configuration.
*
* @param scope The scope creating construct (usually this). This parameter is required.
* @param id The construct's id. This parameter is required.
* @param securityConfigurationName name of external security configuration. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.glue.alpha.ISecurityConfiguration fromSecurityConfigurationName(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String securityConfigurationName) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.services.glue.alpha.SecurityConfiguration.class, "fromSecurityConfigurationName", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.glue.alpha.ISecurityConfiguration.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(securityConfigurationName, "securityConfigurationName is required") });
}
/**
* (experimental) The name of the security configuration.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getSecurityConfigurationName() {
return software.amazon.jsii.Kernel.get(this, "securityConfigurationName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The KMS key used in CloudWatch encryption if it requires a kms key.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.kms.IKey getCloudWatchEncryptionKey() {
return software.amazon.jsii.Kernel.get(this, "cloudWatchEncryptionKey", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.kms.IKey.class));
}
/**
* (experimental) The KMS key used in job bookmarks encryption if it requires a kms key.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.kms.IKey getJobBookmarksEncryptionKey() {
return software.amazon.jsii.Kernel.get(this, "jobBookmarksEncryptionKey", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.kms.IKey.class));
}
/**
* (experimental) The KMS key used in S3 encryption if it requires a kms key.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.kms.IKey getS3EncryptionKey() {
return software.amazon.jsii.Kernel.get(this, "s3EncryptionKey", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.kms.IKey.class));
}
/**
* (experimental) A fluent builder for {@link software.amazon.awscdk.services.glue.alpha.SecurityConfiguration}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
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.Experimental)
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 software.amazon.awscdk.services.glue.alpha.SecurityConfigurationProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
}
/**
* (experimental) The encryption configuration for Amazon CloudWatch Logs.
*
* Default: no cloudwatch logs encryption.
*
* @return {@code this}
* @param cloudWatchEncryption The encryption configuration for Amazon CloudWatch Logs. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder cloudWatchEncryption(final software.amazon.awscdk.services.glue.alpha.CloudWatchEncryption cloudWatchEncryption) {
this.props().cloudWatchEncryption(cloudWatchEncryption);
return this;
}
/**
* (experimental) The encryption configuration for Glue Job Bookmarks.
*
* Default: no job bookmarks encryption.
*
* @return {@code this}
* @param jobBookmarksEncryption The encryption configuration for Glue Job Bookmarks. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder jobBookmarksEncryption(final software.amazon.awscdk.services.glue.alpha.JobBookmarksEncryption jobBookmarksEncryption) {
this.props().jobBookmarksEncryption(jobBookmarksEncryption);
return this;
}
/**
* (experimental) The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
*
* Default: no s3 encryption.
*
* @return {@code this}
* @param s3Encryption The encryption configuration for Amazon Simple Storage Service (Amazon S3) data. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder s3Encryption(final software.amazon.awscdk.services.glue.alpha.S3Encryption s3Encryption) {
this.props().s3Encryption(s3Encryption);
return this;
}
/**
* (experimental) The name of the security configuration.
*
* Default: - generated by CDK.
*
* @return {@code this}
* @param securityConfigurationName The name of the security configuration. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder securityConfigurationName(final java.lang.String securityConfigurationName) {
this.props().securityConfigurationName(securityConfigurationName);
return this;
}
/**
* @return a newly built instance of {@link software.amazon.awscdk.services.glue.alpha.SecurityConfiguration}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public software.amazon.awscdk.services.glue.alpha.SecurityConfiguration build() {
return new software.amazon.awscdk.services.glue.alpha.SecurityConfiguration(
this.scope,
this.id,
this.props != null ? this.props.build() : null
);
}
private software.amazon.awscdk.services.glue.alpha.SecurityConfigurationProps.Builder props() {
if (this.props == null) {
this.props = new software.amazon.awscdk.services.glue.alpha.SecurityConfigurationProps.Builder();
}
return this.props;
}
}
}