JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.gamelift.model

Class ContainerGroupDefinition

    • Constructor Detail

      • ContainerGroupDefinition

        public ContainerGroupDefinition()
    • Method Detail

      • setContainerGroupDefinitionArn

        public void setContainerGroupDefinitionArn(String containerGroupDefinitionArn)

        The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].

        Parameters:
        containerGroupDefinitionArn - The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].
      • getContainerGroupDefinitionArn

        public String getContainerGroupDefinitionArn()

        The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].

        Returns:
        The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].
      • withContainerGroupDefinitionArn

        public ContainerGroupDefinition withContainerGroupDefinitionArn(String containerGroupDefinitionArn)

        The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].

        Parameters:
        containerGroupDefinitionArn - The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCreationTime

        public void setCreationTime(Date creationTime)

        A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        Parameters:
        creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
      • getCreationTime

        public Date getCreationTime()

        A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        Returns:
        A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
      • withCreationTime

        public ContainerGroupDefinition withCreationTime(Date creationTime)

        A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        Parameters:
        creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setOperatingSystem

        public void setOperatingSystem(String operatingSystem)

        The platform required for all containers in the container group definition.

        Parameters:
        operatingSystem - The platform required for all containers in the container group definition.
        See Also:
        ContainerOperatingSystem
      • getOperatingSystem

        public String getOperatingSystem()

        The platform required for all containers in the container group definition.

        Returns:
        The platform required for all containers in the container group definition.
        See Also:
        ContainerOperatingSystem
      • withOperatingSystem

        public ContainerGroupDefinition withOperatingSystem(String operatingSystem)

        The platform required for all containers in the container group definition.

        Parameters:
        operatingSystem - The platform required for all containers in the container group definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContainerOperatingSystem
      • withOperatingSystem

        public ContainerGroupDefinition withOperatingSystem(ContainerOperatingSystem operatingSystem)

        The platform required for all containers in the container group definition.

        Parameters:
        operatingSystem - The platform required for all containers in the container group definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContainerOperatingSystem
      • setName

        public void setName(String name)

        A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

        Parameters:
        name - A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.
      • getName

        public String getName()

        A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

        Returns:
        A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.
      • withName

        public ContainerGroupDefinition withName(String name)

        A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

        Parameters:
        name - A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSchedulingStrategy

        public void setSchedulingStrategy(String schedulingStrategy)

        The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

        Parameters:
        schedulingStrategy - The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.
        See Also:
        ContainerSchedulingStrategy
      • getSchedulingStrategy

        public String getSchedulingStrategy()

        The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

        Returns:
        The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.
        See Also:
        ContainerSchedulingStrategy
      • withSchedulingStrategy

        public ContainerGroupDefinition withSchedulingStrategy(String schedulingStrategy)

        The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

        Parameters:
        schedulingStrategy - The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContainerSchedulingStrategy
      • withSchedulingStrategy

        public ContainerGroupDefinition withSchedulingStrategy(ContainerSchedulingStrategy schedulingStrategy)

        The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

        Parameters:
        schedulingStrategy - The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContainerSchedulingStrategy
      • setTotalMemoryLimit

        public void setTotalMemoryLimit(Integer totalMemoryLimit)

        The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

        • Equal to or greater than the sum of all container-specific soft memory limits in the group.

        • Equal to or greater than any container-specific hard limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

        Parameters:
        totalMemoryLimit - The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

        • Equal to or greater than the sum of all container-specific soft memory limits in the group.

        • Equal to or greater than any container-specific hard limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

      • getTotalMemoryLimit

        public Integer getTotalMemoryLimit()

        The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

        • Equal to or greater than the sum of all container-specific soft memory limits in the group.

        • Equal to or greater than any container-specific hard limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

        Returns:
        The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

        • Equal to or greater than the sum of all container-specific soft memory limits in the group.

        • Equal to or greater than any container-specific hard limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

      • withTotalMemoryLimit

        public ContainerGroupDefinition withTotalMemoryLimit(Integer totalMemoryLimit)

        The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

        • Equal to or greater than the sum of all container-specific soft memory limits in the group.

        • Equal to or greater than any container-specific hard limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

        Parameters:
        totalMemoryLimit - The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

        • Equal to or greater than the sum of all container-specific soft memory limits in the group.

        • Equal to or greater than any container-specific hard limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setTotalCpuLimit

        public void setTotalCpuLimit(Integer totalCpuLimit)

        The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

        Parameters:
        totalCpuLimit - The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

      • getTotalCpuLimit

        public Integer getTotalCpuLimit()

        The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

        Returns:
        The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

      • withTotalCpuLimit

        public ContainerGroupDefinition withTotalCpuLimit(Integer totalCpuLimit)

        The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

        Parameters:
        totalCpuLimit - The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

        You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

        For more details on memory allocation, see the Container fleet design guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getContainerDefinitions

        public List<ContainerDefinition> getContainerDefinitions()

        The set of container definitions that are included in the container group.

        Returns:
        The set of container definitions that are included in the container group.
      • setContainerDefinitions

        public void setContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)

        The set of container definitions that are included in the container group.

        Parameters:
        containerDefinitions - The set of container definitions that are included in the container group.
      • withContainerDefinitions

        public ContainerGroupDefinition withContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)

        The set of container definitions that are included in the container group.

        Parameters:
        containerDefinitions - The set of container definitions that are included in the container group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setStatus

        public void setStatus(String status)

        Current status of the container group definition resource. Values include:

        • COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

        • READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

        • FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

        Parameters:
        status - Current status of the container group definition resource. Values include:

        • COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

        • READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

        • FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

        See Also:
        ContainerGroupDefinitionStatus
      • getStatus

        public String getStatus()

        Current status of the container group definition resource. Values include:

        • COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

        • READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

        • FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

        Returns:
        Current status of the container group definition resource. Values include:

        • COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

        • READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

        • FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

        See Also:
        ContainerGroupDefinitionStatus
      • withStatus

        public ContainerGroupDefinition withStatus(String status)

        Current status of the container group definition resource. Values include:

        • COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

        • READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

        • FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

        Parameters:
        status - Current status of the container group definition resource. Values include:

        • COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

        • READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

        • FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContainerGroupDefinitionStatus
      • withStatus

        public ContainerGroupDefinition withStatus(ContainerGroupDefinitionStatus status)

        Current status of the container group definition resource. Values include:

        • COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

        • READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

        • FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

        Parameters:
        status - Current status of the container group definition resource. Values include:

        • COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

        • READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

        • FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContainerGroupDefinitionStatus
      • setStatusReason

        public void setStatusReason(String statusReason)

        Additional information about a container group definition that's in FAILED status. Possible reasons include:

        • An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

        • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

        • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

        • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

        • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

        Parameters:
        statusReason - Additional information about a container group definition that's in FAILED status. Possible reasons include:

        • An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

        • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

        • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

        • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

        • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

      • getStatusReason

        public String getStatusReason()

        Additional information about a container group definition that's in FAILED status. Possible reasons include:

        • An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

        • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

        • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

        • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

        • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

        Returns:
        Additional information about a container group definition that's in FAILED status. Possible reasons include:

        • An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

        • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

        • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

        • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

        • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

      • withStatusReason

        public ContainerGroupDefinition withStatusReason(String statusReason)

        Additional information about a container group definition that's in FAILED status. Possible reasons include:

        • An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

        • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

        • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

        • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

        • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

        Parameters:
        statusReason - Additional information about a container group definition that's in FAILED status. Possible reasons include:

        • An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

        • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

        • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

        • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

        • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public 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
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /