/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace finspace { namespace Model { /** *

Represents an FinSpace environment.

See Also:

AWS * API Reference

*/ class Environment { public: AWS_FINSPACE_API Environment(); AWS_FINSPACE_API Environment(Aws::Utils::Json::JsonView jsonValue); AWS_FINSPACE_API Environment& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_FINSPACE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the FinSpace environment.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the FinSpace environment.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the FinSpace environment.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the FinSpace environment.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the FinSpace environment.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the FinSpace environment.

*/ inline Environment& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the FinSpace environment.

*/ inline Environment& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the FinSpace environment.

*/ inline Environment& WithName(const char* value) { SetName(value); return *this;} /** *

The identifier of the FinSpace environment.

*/ inline const Aws::String& GetEnvironmentId() const{ return m_environmentId; } /** *

The identifier of the FinSpace environment.

*/ inline bool EnvironmentIdHasBeenSet() const { return m_environmentIdHasBeenSet; } /** *

The identifier of the FinSpace environment.

*/ inline void SetEnvironmentId(const Aws::String& value) { m_environmentIdHasBeenSet = true; m_environmentId = value; } /** *

The identifier of the FinSpace environment.

*/ inline void SetEnvironmentId(Aws::String&& value) { m_environmentIdHasBeenSet = true; m_environmentId = std::move(value); } /** *

The identifier of the FinSpace environment.

*/ inline void SetEnvironmentId(const char* value) { m_environmentIdHasBeenSet = true; m_environmentId.assign(value); } /** *

The identifier of the FinSpace environment.

*/ inline Environment& WithEnvironmentId(const Aws::String& value) { SetEnvironmentId(value); return *this;} /** *

The identifier of the FinSpace environment.

*/ inline Environment& WithEnvironmentId(Aws::String&& value) { SetEnvironmentId(std::move(value)); return *this;} /** *

The identifier of the FinSpace environment.

*/ inline Environment& WithEnvironmentId(const char* value) { SetEnvironmentId(value); return *this;} /** *

The ID of the AWS account in which the FinSpace environment is created.

*/ inline const Aws::String& GetAwsAccountId() const{ return m_awsAccountId; } /** *

The ID of the AWS account in which the FinSpace environment is created.

*/ inline bool AwsAccountIdHasBeenSet() const { return m_awsAccountIdHasBeenSet; } /** *

The ID of the AWS account in which the FinSpace environment is created.

*/ inline void SetAwsAccountId(const Aws::String& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = value; } /** *

The ID of the AWS account in which the FinSpace environment is created.

*/ inline void SetAwsAccountId(Aws::String&& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = std::move(value); } /** *

The ID of the AWS account in which the FinSpace environment is created.

*/ inline void SetAwsAccountId(const char* value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId.assign(value); } /** *

The ID of the AWS account in which the FinSpace environment is created.

*/ inline Environment& WithAwsAccountId(const Aws::String& value) { SetAwsAccountId(value); return *this;} /** *

The ID of the AWS account in which the FinSpace environment is created.

*/ inline Environment& WithAwsAccountId(Aws::String&& value) { SetAwsAccountId(std::move(value)); return *this;} /** *

The ID of the AWS account in which the FinSpace environment is created.

*/ inline Environment& WithAwsAccountId(const char* value) { SetAwsAccountId(value); return *this;} /** *

The current status of creation of the FinSpace environment.

*/ inline const EnvironmentStatus& GetStatus() const{ return m_status; } /** *

The current status of creation of the FinSpace environment.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The current status of creation of the FinSpace environment.

*/ inline void SetStatus(const EnvironmentStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The current status of creation of the FinSpace environment.

*/ inline void SetStatus(EnvironmentStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The current status of creation of the FinSpace environment.

*/ inline Environment& WithStatus(const EnvironmentStatus& value) { SetStatus(value); return *this;} /** *

The current status of creation of the FinSpace environment.

*/ inline Environment& WithStatus(EnvironmentStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

The sign-in URL for the web application of your FinSpace environment.

*/ inline const Aws::String& GetEnvironmentUrl() const{ return m_environmentUrl; } /** *

The sign-in URL for the web application of your FinSpace environment.

*/ inline bool EnvironmentUrlHasBeenSet() const { return m_environmentUrlHasBeenSet; } /** *

The sign-in URL for the web application of your FinSpace environment.

*/ inline void SetEnvironmentUrl(const Aws::String& value) { m_environmentUrlHasBeenSet = true; m_environmentUrl = value; } /** *

The sign-in URL for the web application of your FinSpace environment.

*/ inline void SetEnvironmentUrl(Aws::String&& value) { m_environmentUrlHasBeenSet = true; m_environmentUrl = std::move(value); } /** *

The sign-in URL for the web application of your FinSpace environment.

*/ inline void SetEnvironmentUrl(const char* value) { m_environmentUrlHasBeenSet = true; m_environmentUrl.assign(value); } /** *

The sign-in URL for the web application of your FinSpace environment.

*/ inline Environment& WithEnvironmentUrl(const Aws::String& value) { SetEnvironmentUrl(value); return *this;} /** *

The sign-in URL for the web application of your FinSpace environment.

*/ inline Environment& WithEnvironmentUrl(Aws::String&& value) { SetEnvironmentUrl(std::move(value)); return *this;} /** *

The sign-in URL for the web application of your FinSpace environment.

*/ inline Environment& WithEnvironmentUrl(const char* value) { SetEnvironmentUrl(value); return *this;} /** *

The description of the FinSpace environment.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The description of the FinSpace environment.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The description of the FinSpace environment.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The description of the FinSpace environment.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The description of the FinSpace environment.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The description of the FinSpace environment.

*/ inline Environment& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The description of the FinSpace environment.

*/ inline Environment& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The description of the FinSpace environment.

*/ inline Environment& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The Amazon Resource Name (ARN) of your FinSpace environment.

*/ inline const Aws::String& GetEnvironmentArn() const{ return m_environmentArn; } /** *

The Amazon Resource Name (ARN) of your FinSpace environment.

*/ inline bool EnvironmentArnHasBeenSet() const { return m_environmentArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of your FinSpace environment.

*/ inline void SetEnvironmentArn(const Aws::String& value) { m_environmentArnHasBeenSet = true; m_environmentArn = value; } /** *

The Amazon Resource Name (ARN) of your FinSpace environment.

*/ inline void SetEnvironmentArn(Aws::String&& value) { m_environmentArnHasBeenSet = true; m_environmentArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of your FinSpace environment.

*/ inline void SetEnvironmentArn(const char* value) { m_environmentArnHasBeenSet = true; m_environmentArn.assign(value); } /** *

The Amazon Resource Name (ARN) of your FinSpace environment.

*/ inline Environment& WithEnvironmentArn(const Aws::String& value) { SetEnvironmentArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of your FinSpace environment.

*/ inline Environment& WithEnvironmentArn(Aws::String&& value) { SetEnvironmentArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of your FinSpace environment.

*/ inline Environment& WithEnvironmentArn(const char* value) { SetEnvironmentArn(value); return *this;} /** *

The URL of the integrated FinSpace notebook environment in your web * application.

*/ inline const Aws::String& GetSageMakerStudioDomainUrl() const{ return m_sageMakerStudioDomainUrl; } /** *

The URL of the integrated FinSpace notebook environment in your web * application.

*/ inline bool SageMakerStudioDomainUrlHasBeenSet() const { return m_sageMakerStudioDomainUrlHasBeenSet; } /** *

The URL of the integrated FinSpace notebook environment in your web * application.

*/ inline void SetSageMakerStudioDomainUrl(const Aws::String& value) { m_sageMakerStudioDomainUrlHasBeenSet = true; m_sageMakerStudioDomainUrl = value; } /** *

The URL of the integrated FinSpace notebook environment in your web * application.

*/ inline void SetSageMakerStudioDomainUrl(Aws::String&& value) { m_sageMakerStudioDomainUrlHasBeenSet = true; m_sageMakerStudioDomainUrl = std::move(value); } /** *

The URL of the integrated FinSpace notebook environment in your web * application.

*/ inline void SetSageMakerStudioDomainUrl(const char* value) { m_sageMakerStudioDomainUrlHasBeenSet = true; m_sageMakerStudioDomainUrl.assign(value); } /** *

The URL of the integrated FinSpace notebook environment in your web * application.

*/ inline Environment& WithSageMakerStudioDomainUrl(const Aws::String& value) { SetSageMakerStudioDomainUrl(value); return *this;} /** *

The URL of the integrated FinSpace notebook environment in your web * application.

*/ inline Environment& WithSageMakerStudioDomainUrl(Aws::String&& value) { SetSageMakerStudioDomainUrl(std::move(value)); return *this;} /** *

The URL of the integrated FinSpace notebook environment in your web * application.

*/ inline Environment& WithSageMakerStudioDomainUrl(const char* value) { SetSageMakerStudioDomainUrl(value); return *this;} /** *

The KMS key id used to encrypt in the FinSpace environment.

*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *

The KMS key id used to encrypt in the FinSpace environment.

*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

The KMS key id used to encrypt in the FinSpace environment.

*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

The KMS key id used to encrypt in the FinSpace environment.

*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

The KMS key id used to encrypt in the FinSpace environment.

*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

The KMS key id used to encrypt in the FinSpace environment.

*/ inline Environment& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

The KMS key id used to encrypt in the FinSpace environment.

*/ inline Environment& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

The KMS key id used to encrypt in the FinSpace environment.

*/ inline Environment& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} /** *

The AWS account ID of the dedicated service account associated with your * FinSpace environment.

*/ inline const Aws::String& GetDedicatedServiceAccountId() const{ return m_dedicatedServiceAccountId; } /** *

The AWS account ID of the dedicated service account associated with your * FinSpace environment.

*/ inline bool DedicatedServiceAccountIdHasBeenSet() const { return m_dedicatedServiceAccountIdHasBeenSet; } /** *

The AWS account ID of the dedicated service account associated with your * FinSpace environment.

*/ inline void SetDedicatedServiceAccountId(const Aws::String& value) { m_dedicatedServiceAccountIdHasBeenSet = true; m_dedicatedServiceAccountId = value; } /** *

The AWS account ID of the dedicated service account associated with your * FinSpace environment.

*/ inline void SetDedicatedServiceAccountId(Aws::String&& value) { m_dedicatedServiceAccountIdHasBeenSet = true; m_dedicatedServiceAccountId = std::move(value); } /** *

The AWS account ID of the dedicated service account associated with your * FinSpace environment.

*/ inline void SetDedicatedServiceAccountId(const char* value) { m_dedicatedServiceAccountIdHasBeenSet = true; m_dedicatedServiceAccountId.assign(value); } /** *

The AWS account ID of the dedicated service account associated with your * FinSpace environment.

*/ inline Environment& WithDedicatedServiceAccountId(const Aws::String& value) { SetDedicatedServiceAccountId(value); return *this;} /** *

The AWS account ID of the dedicated service account associated with your * FinSpace environment.

*/ inline Environment& WithDedicatedServiceAccountId(Aws::String&& value) { SetDedicatedServiceAccountId(std::move(value)); return *this;} /** *

The AWS account ID of the dedicated service account associated with your * FinSpace environment.

*/ inline Environment& WithDedicatedServiceAccountId(const char* value) { SetDedicatedServiceAccountId(value); return *this;} /** *

The authentication mode for the environment.

*/ inline const FederationMode& GetFederationMode() const{ return m_federationMode; } /** *

The authentication mode for the environment.

*/ inline bool FederationModeHasBeenSet() const { return m_federationModeHasBeenSet; } /** *

The authentication mode for the environment.

*/ inline void SetFederationMode(const FederationMode& value) { m_federationModeHasBeenSet = true; m_federationMode = value; } /** *

The authentication mode for the environment.

*/ inline void SetFederationMode(FederationMode&& value) { m_federationModeHasBeenSet = true; m_federationMode = std::move(value); } /** *

The authentication mode for the environment.

*/ inline Environment& WithFederationMode(const FederationMode& value) { SetFederationMode(value); return *this;} /** *

The authentication mode for the environment.

*/ inline Environment& WithFederationMode(FederationMode&& value) { SetFederationMode(std::move(value)); return *this;} /** *

Configuration information when authentication mode is FEDERATED.

*/ inline const FederationParameters& GetFederationParameters() const{ return m_federationParameters; } /** *

Configuration information when authentication mode is FEDERATED.

*/ inline bool FederationParametersHasBeenSet() const { return m_federationParametersHasBeenSet; } /** *

Configuration information when authentication mode is FEDERATED.

*/ inline void SetFederationParameters(const FederationParameters& value) { m_federationParametersHasBeenSet = true; m_federationParameters = value; } /** *

Configuration information when authentication mode is FEDERATED.

*/ inline void SetFederationParameters(FederationParameters&& value) { m_federationParametersHasBeenSet = true; m_federationParameters = std::move(value); } /** *

Configuration information when authentication mode is FEDERATED.

*/ inline Environment& WithFederationParameters(const FederationParameters& value) { SetFederationParameters(value); return *this;} /** *

Configuration information when authentication mode is FEDERATED.

*/ inline Environment& WithFederationParameters(FederationParameters&& value) { SetFederationParameters(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_environmentId; bool m_environmentIdHasBeenSet = false; Aws::String m_awsAccountId; bool m_awsAccountIdHasBeenSet = false; EnvironmentStatus m_status; bool m_statusHasBeenSet = false; Aws::String m_environmentUrl; bool m_environmentUrlHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_environmentArn; bool m_environmentArnHasBeenSet = false; Aws::String m_sageMakerStudioDomainUrl; bool m_sageMakerStudioDomainUrlHasBeenSet = false; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet = false; Aws::String m_dedicatedServiceAccountId; bool m_dedicatedServiceAccountIdHasBeenSet = false; FederationMode m_federationMode; bool m_federationModeHasBeenSet = false; FederationParameters m_federationParameters; bool m_federationParametersHasBeenSet = false; }; } // namespace Model } // namespace finspace } // namespace Aws