Package software.amazon.awssdk.services.proton.model

Class CreateEnvironmentRequest

    • Method Detail

      • codebuildRoleArn

        public final String codebuildRoleArn()

        The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

        To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

        Returns:
        The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

        To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

      • componentRoleArn

        public final String componentRoleArn()

        The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

        You must specify componentRoleArn to allow directly defined components to be associated with this environment.

        For more information about components, see Proton components in the Proton User Guide.

        Returns:
        The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

        You must specify componentRoleArn to allow directly defined components to be associated with this environment.

        For more information about components, see Proton components in the Proton User Guide.

      • description

        public final String description()

        A description of the environment that's being created and deployed.

        Returns:
        A description of the environment that's being created and deployed.

      • environmentAccountConnectionId

        public final String environmentAccountConnectionId()

        The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.

        To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

        Returns:
        The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.

        To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

      • name

        public final String name()

        The name of the environment.

        Returns:
        The name of the environment.

      • protonServiceRoleArn

        public final String protonServiceRoleArn()

        The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

        To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

        Returns:
        The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

        To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

      • provisioningRepository

        public final RepositoryBranchInput provisioningRepository()

        The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

        To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

        Returns:
        The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

        To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

      • spec

        public final String spec()

        A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.

        Returns:
        A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

        For more information, see Proton resources and tagging in the Proton User Guide.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

        For more information, see Proton resources and tagging in the Proton User Guide.

      • templateMajorVersion

        public final String templateMajorVersion()

        The major version of the environment template.

        Returns:
        The major version of the environment template.

      • templateMinorVersion

        public final String templateMinorVersion()

        The minor version of the environment template.

        Returns:
        The minor version of the environment template.

      • templateName

        public final String templateName()

        The name of the environment template. For more information, see Environment Templates in the Proton User Guide.

        Returns:
        The name of the environment template. For more information, see Environment Templates in the Proton User Guide.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object