Package software.amazon.awssdk.services.appconfig.model

Class CreateDeploymentStrategyRequest

    • Method Detail

      • name

        public final String name()

        A name for the deployment strategy.

        Returns:
        A name for the deployment strategy.

      • description

        public final String description()

        A description of the deployment strategy.

        Returns:
        A description of the deployment strategy.

      • deploymentDurationInMinutes

        public final Integer deploymentDurationInMinutes()

        Total amount of time for a deployment to last.

        Returns:
        Total amount of time for a deployment to last.

      • finalBakeTimeInMinutes

        public final Integer finalBakeTimeInMinutes()

        Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

        Returns:
        Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

      • growthFactor

        public final Float growthFactor()

        The percentage of targets to receive a deployed configuration during each interval.

        Returns:
        The percentage of targets to receive a deployed configuration during each interval.

      • growthType

        public final GrowthType growthType()

        The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

        Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

        Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

        2*(2^0)

        2*(2^1)

        2*(2^2)

        Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

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

        Returns:
        The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

        Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

        Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

        2*(2^0)

        2*(2^1)

        2*(2^2)

        Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

        See Also:
        GrowthType

      • growthTypeAsString

        public final String growthTypeAsString()

        The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

        Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

        Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

        2*(2^0)

        2*(2^1)

        2*(2^2)

        Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

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

        Returns:
        The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

        Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

        Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

        2*(2^0)

        2*(2^1)

        2*(2^2)

        Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

        See Also:
        GrowthType

      • replicateTo

        public final ReplicateTo replicateTo()

        Save the deployment strategy to a Systems Manager (SSM) document.

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

        Returns:
        Save the deployment strategy to a Systems Manager (SSM) document.
        See Also:
        ReplicateTo

      • replicateToAsString

        public final String replicateToAsString()

        Save the deployment strategy to a Systems Manager (SSM) document.

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

        Returns:
        Save the deployment strategy to a Systems Manager (SSM) document.
        See Also:
        ReplicateTo

      • 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()

        Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

        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:
        Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

      • 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