Package software.amazon.awssdk.services.elasticbeanstalk.model

Class CreateConfigurationTemplateRequest

    • Method Detail

      • applicationName

        public final String applicationName()

        The name of the Elastic Beanstalk application to associate with this configuration template.

        Returns:
        The name of the Elastic Beanstalk application to associate with this configuration template.

      • templateName

        public final String templateName()

        The name of the configuration template.

        Constraint: This name must be unique per application.

        Returns:
        The name of the configuration template.

        Constraint: This name must be unique per application.

      • solutionStackName

        public final String solutionStackName()

        The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.

        You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.

        Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

        Returns:
        The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.

        You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.

        Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

      • platformArn

        public final String platformArn()

        The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.

        If you specify PlatformArn, then don't specify SolutionStackName.

        Returns:
        The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.

        If you specify PlatformArn, then don't specify SolutionStackName.

      • sourceConfiguration

        public final SourceConfiguration sourceConfiguration()

        An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

        Values specified in OptionSettings override any values obtained from the SourceConfiguration.

        You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

        Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.

        Returns:
        An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

        Values specified in OptionSettings override any values obtained from the SourceConfiguration.

        You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

        Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.

      • environmentId

        public final String environmentId()

        The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.

        Returns:
        The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.

      • description

        public final String description()

        An optional description for this configuration.

        Returns:
        An optional description for this configuration.

      • hasOptionSettings

        public final boolean hasOptionSettings()
        For responses, this returns true if the service returned a value for the OptionSettings 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.

      • optionSettings

        public final List<ConfigurationOptionSetting> optionSettings()

        Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer 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 hasOptionSettings() method.

        Returns:
        Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer 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()

        Specifies the tags applied to the configuration template.

        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:
        Specifies the tags applied to the configuration template.

      • 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