Package software.amazon.awssdk.services.m2.model

Class CreateEnvironmentRequest

    • Method Detail

      • clientToken

        public final String clientToken()

        Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

        Returns:
        Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

      • description

        public final String description()

        The description of the runtime environment.

        Returns:
        The description of the runtime environment.

      • engineTypeAsString

        public final String engineTypeAsString()

        The engine type for the runtime environment.

        If the service returns an enum value that is not available in the current SDK version, engineType will return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().

        Returns:
        The engine type for the runtime environment.
        See Also:
        EngineType

      • engineVersion

        public final String engineVersion()

        The version of the engine type for the runtime environment.

        Returns:
        The version of the engine type for the runtime environment.

      • highAvailabilityConfig

        public final HighAvailabilityConfig highAvailabilityConfig()

        The details of a high availability configuration for this runtime environment.

        Returns:
        The details of a high availability configuration for this runtime environment.

      • instanceType

        public final String instanceType()

        The type of instance for the runtime environment.

        Returns:
        The type of instance for the runtime environment.

      • kmsKeyId

        public final String kmsKeyId()

        The identifier of a customer managed key.

        Returns:
        The identifier of a customer managed key.

      • name

        public final String name()

        The name of the runtime environment. Must be unique within the account.

        Returns:
        The name of the runtime environment. Must be unique within the account.

      • preferredMaintenanceWindow

        public final String preferredMaintenanceWindow()

        Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

        If you do not provide a value, a random system-generated value will be assigned.

        Returns:
        Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

        If you do not provide a value, a random system-generated value will be assigned.

      • publiclyAccessible

        public final Boolean publiclyAccessible()

        Specifies whether the runtime environment is publicly accessible.

        Returns:
        Specifies whether the runtime environment is publicly accessible.

      • hasSecurityGroupIds

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

      • securityGroupIds

        public final List<String> securityGroupIds()

        The list of security groups for the VPC associated with this runtime environment.

        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 hasSecurityGroupIds() method.

        Returns:
        The list of security groups for the VPC associated with this runtime environment.

      • hasStorageConfigurations

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

      • storageConfigurations

        public final List<StorageConfiguration> storageConfigurations()

        Optional. The storage configurations for this runtime environment.

        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 hasStorageConfigurations() method.

        Returns:
        Optional. The storage configurations for this runtime environment.

      • hasSubnetIds

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

      • subnetIds

        public final List<String> subnetIds()

        The list of subnets associated with the VPC for this runtime environment.

        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 hasSubnetIds() method.

        Returns:
        The list of subnets associated with the VPC for this runtime environment.

      • 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 Map<String,​String> tags()

        The tags for the runtime environment.

        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:
        The tags for the runtime environment.

      • 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