Package software.amazon.awssdk.services.codebuild.model

Interface EnvironmentVariable.Builder

    • Method Detail

      • name

        EnvironmentVariable.Builder name​(String name)

        The name or key of the environment variable.

        Parameters:
        name - The name or key of the environment variable.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • value

        EnvironmentVariable.Builder value​(String value)

        The value of the environment variable.

        We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

        Parameters:
        value - The value of the environment variable.

        We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • type

        EnvironmentVariable.Builder type​(String type)

        The type of environment variable. Valid values include:

        • PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.

        • PLAINTEXT: An environment variable in plain text format. This is the default value.

        • SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

        Parameters:
        type - The type of environment variable. Valid values include:

        • PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.

        • PLAINTEXT: An environment variable in plain text format. This is the default value.

        • SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnvironmentVariableType, EnvironmentVariableType

      • type

        EnvironmentVariable.Builder type​(EnvironmentVariableType type)

        The type of environment variable. Valid values include:

        • PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.

        • PLAINTEXT: An environment variable in plain text format. This is the default value.

        • SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

        Parameters:
        type - The type of environment variable. Valid values include:

        • PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.

        • PLAINTEXT: An environment variable in plain text format. This is the default value.

        • SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnvironmentVariableType, EnvironmentVariableType