io.github.cdklabs.cdk.data.zone.EnvironmentProfile Maven / Gradle / Ivy
Show all versions of cdk-data-zone Show documentation
package io.github.cdklabs.cdk.data.zone;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-12-05T19:37:12.576Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdk.data.zone.$Module.class, fqn = "cdk-data-zone.EnvironmentProfile")
public class EnvironmentProfile extends io.github.cdklabs.cdk.data.zone.EnvironmentProfileBase {
protected EnvironmentProfile(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected EnvironmentProfile(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.Experimental)
public EnvironmentProfile(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.cdk.data.zone.EnvironmentProfileProps 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") });
}
/**
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getAwsAccountId() {
return software.amazon.jsii.Kernel.get(this, "awsAccountId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getAwsAccountRegion() {
return software.amazon.jsii.Kernel.get(this, "awsAccountRegion", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The timestamp of when an environment profile was created.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getCreatedAt() {
return software.amazon.jsii.Kernel.get(this, "createdAt", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The Amazon user who created the environment profile.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getCreatedBy() {
return software.amazon.jsii.Kernel.get(this, "createdBy", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The identifier of a blueprint with which an environment profile is created.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getEnvironmentBlueprintId() {
return software.amazon.jsii.Kernel.get(this, "environmentBlueprintId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The identifier of the environment profile.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getEnvironmentProfileId() {
return software.amazon.jsii.Kernel.get(this, "environmentProfileId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getName() {
return software.amazon.jsii.Kernel.get(this, "name", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The identifier of a project in which an environment profile exists.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.data.zone.IProject getProject() {
return software.amazon.jsii.Kernel.get(this, "project", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdk.data.zone.IProject.class));
}
/**
* (experimental) The timestamp of when the environment profile was updated.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getUpdatedAt() {
return software.amazon.jsii.Kernel.get(this, "updatedAt", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getDescription() {
return software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.cdk.data.zone.EnvironmentProfile}.
*/
@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 final io.github.cdklabs.cdk.data.zone.EnvironmentProfileProps.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.cdk.data.zone.EnvironmentProfileProps.Builder();
}
/**
* (experimental) The identifier of a blueprint with which an environment profile is created.
*
* @return {@code this}
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-environmentblueprintidentifier
* @param blueprint The identifier of a blueprint with which an environment profile is created. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder blueprint(final io.github.cdklabs.cdk.data.zone.IBlueprint blueprint) {
this.props.blueprint(blueprint);
return this;
}
/**
* (experimental) The name of the environment profile.
*
* @return {@code this}
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-name
* @param name The name of the environment profile. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder name(final java.lang.String name) {
this.props.name(name);
return this;
}
/**
* (experimental) The identifier of a project in which an environment profile exists.
*
* @return {@code this}
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-projectidentifier
* @param project The identifier of a project in which an environment profile exists. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder project(final io.github.cdklabs.cdk.data.zone.IProject project) {
this.props.project(project);
return this;
}
/**
* (experimental) The identifier of an AWS account in which an environment profile exists.
*
* Default: the Domain account
*
* @return {@code this}
* @param awsAccountId The identifier of an AWS account in which an environment profile exists. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder awsAccountId(final java.lang.String awsAccountId) {
this.props.awsAccountId(awsAccountId);
return this;
}
/**
* (experimental) The AWS Region in which an environment profile exists.
*
* Default: the Domain region
*
* @return {@code this}
* @param awsAccountRegion The AWS Region in which an environment profile exists. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder awsAccountRegion(final java.lang.String awsAccountRegion) {
this.props.awsAccountRegion(awsAccountRegion);
return this;
}
/**
* (experimental) The description of the environment profile.
*
* @return {@code this}
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-description
* @param description The description of the environment profile. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder description(final java.lang.String description) {
this.props.description(description);
return this;
}
/**
* (experimental) The user parameters of this Amazon environment profile.
*
* @return {@code this}
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-userparameters
* @param userParameters The user parameters of this Amazon environment profile. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder userParameters(final software.amazon.awscdk.IResolvable userParameters) {
this.props.userParameters(userParameters);
return this;
}
/**
* (experimental) The user parameters of this Amazon environment profile.
*
* @return {@code this}
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-userparameters
* @param userParameters The user parameters of this Amazon environment profile. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder userParameters(final java.util.List userParameters) {
this.props.userParameters(userParameters);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.cdk.data.zone.EnvironmentProfile}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.cdk.data.zone.EnvironmentProfile build() {
return new io.github.cdklabs.cdk.data.zone.EnvironmentProfile(
this.scope,
this.id,
this.props.build()
);
}
}
}