Container for the parameters to the DeleteContainerGroupDefinition operation. Deletes a container group definition.
Request options:
-
Delete an entire container group definition, including all versions. Specify the container group definition name, or use an ARN value without the version number.
-
Delete a particular version. Specify the container group definition name and a version number, or use an ARN value that includes the version number.
-
Keep the newest versions and delete all older versions. Specify the container group definition name and the number of versions to retain. For example, set
VersionCountToRetainto 5 to delete all but the five most recent versions.
Result
If successful, Amazon GameLift removes the container group definition versions that you request deletion for. This request will fail for any requested versions if the following is true:
-
If the version is being used in an active fleet
-
If the version is being deployed to a fleet in a deployment that's currently in progress.
-
If the version is designated as a rollback definition in a fleet deployment that's currently in progress.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.DeleteContainerGroupDefinitionRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class DeleteContainerGroupDefinitionRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The DeleteContainerGroupDefinitionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DeleteContainerGroupDefinitionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Name | System.String |
Gets and sets the property Name.
The unique identifier for the container group definition to delete. You can use either
the |
|
|
VersionCountToRetain | System.Int32 |
Gets and sets the property VersionCountToRetain. The number of most recent versions to keep while deleting all older versions. |
|
|
VersionNumber | System.Int32 |
Gets and sets the property VersionNumber. The specific version to delete. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5