CreateContainerInstanceDetails¶

class oci.container_instances.models.CreateContainerInstanceDetails(**kwargs)¶

Bases: object

Information to create a container instance.

Methods:

__init__(**kwargs)

Initializes a new CreateContainerInstanceDetails object with values from keyword arguments.

Attributes:

`availability_domain`	[Required] Gets the availability_domain of this CreateContainerInstanceDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateContainerInstanceDetails.
`container_restart_policy`	Gets the container_restart_policy of this CreateContainerInstanceDetails.
`containers`	[Required] Gets the containers of this CreateContainerInstanceDetails.
`defined_tags`	Gets the defined_tags of this CreateContainerInstanceDetails.
`display_name`	Gets the display_name of this CreateContainerInstanceDetails.
`dns_config`	Gets the dns_config of this CreateContainerInstanceDetails.
`fault_domain`	Gets the fault_domain of this CreateContainerInstanceDetails.
`freeform_tags`	Gets the freeform_tags of this CreateContainerInstanceDetails.
`graceful_shutdown_timeout_in_seconds`	Gets the graceful_shutdown_timeout_in_seconds of this CreateContainerInstanceDetails.
`image_pull_secrets`	Gets the image_pull_secrets of this CreateContainerInstanceDetails.
`security_context`	Gets the security_context of this CreateContainerInstanceDetails.
`shape`	[Required] Gets the shape of this CreateContainerInstanceDetails.
`shape_config`	[Required] Gets the shape_config of this CreateContainerInstanceDetails.
`vnics`	[Required] Gets the vnics of this CreateContainerInstanceDetails.
`volumes`	Gets the volumes of this CreateContainerInstanceDetails.

__init__(**kwargs)¶

Initializes a new CreateContainerInstanceDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

display_name (str) – The value to assign to the display_name property of this CreateContainerInstanceDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateContainerInstanceDetails.
availability_domain (str) – The value to assign to the availability_domain property of this CreateContainerInstanceDetails.
fault_domain (str) – The value to assign to the fault_domain property of this CreateContainerInstanceDetails.
shape (str) – The value to assign to the shape property of this CreateContainerInstanceDetails.
shape_config (oci.container_instances.models.CreateContainerInstanceShapeConfigDetails) – The value to assign to the shape_config property of this CreateContainerInstanceDetails.
volumes (list[oci.container_instances.models.CreateContainerVolumeDetails]) – The value to assign to the volumes property of this CreateContainerInstanceDetails.
containers (list[oci.container_instances.models.CreateContainerDetails]) – The value to assign to the containers property of this CreateContainerInstanceDetails.
vnics (list[oci.container_instances.models.CreateContainerVnicDetails]) – The value to assign to the vnics property of this CreateContainerInstanceDetails.
dns_config (oci.container_instances.models.CreateContainerDnsConfigDetails) – The value to assign to the dns_config property of this CreateContainerInstanceDetails.
graceful_shutdown_timeout_in_seconds (int) – The value to assign to the graceful_shutdown_timeout_in_seconds property of this CreateContainerInstanceDetails.
image_pull_secrets (list[oci.container_instances.models.CreateImagePullSecretDetails]) – The value to assign to the image_pull_secrets property of this CreateContainerInstanceDetails.
container_restart_policy (str) – The value to assign to the container_restart_policy property of this CreateContainerInstanceDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateContainerInstanceDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateContainerInstanceDetails.
security_context (oci.container_instances.models.CreateContainerInstanceSecurityContextDetails) – The value to assign to the security_context property of this CreateContainerInstanceDetails.

property availability_domain¶

[Required] Gets the availability_domain of this CreateContainerInstanceDetails. The availability domain where the container instance runs.

Returns: The availability_domain of this CreateContainerInstanceDetails.
Return type: str

property compartment_id¶

[Required] Gets the compartment_id of this CreateContainerInstanceDetails. The compartment OCID.

Returns: The compartment_id of this CreateContainerInstanceDetails.
Return type: str

property container_restart_policy¶

Gets the container_restart_policy of this CreateContainerInstanceDetails. Container restart policy

Returns: The container_restart_policy of this CreateContainerInstanceDetails.
Return type: str

property containers¶

[Required] Gets the containers of this CreateContainerInstanceDetails. The containers to create on this container instance.

Returns: The containers of this CreateContainerInstanceDetails.
Return type: list[oci.container_instances.models.CreateContainerDetails]

property defined_tags¶

Gets the defined_tags of this CreateContainerInstanceDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}.

Returns: The defined_tags of this CreateContainerInstanceDetails.
Return type: dict(str, dict(str, object))

property display_name¶

Gets the display_name of this CreateContainerInstanceDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information. If you don’t provide a name, a name is generated automatically.

Returns: The display_name of this CreateContainerInstanceDetails.
Return type: str

property dns_config¶

Gets the dns_config of this CreateContainerInstanceDetails.

Returns: The dns_config of this CreateContainerInstanceDetails.
Return type: oci.container_instances.models.CreateContainerDnsConfigDetails

property fault_domain¶

Gets the fault_domain of this CreateContainerInstanceDetails. The fault domain where the container instance runs.

Returns: The fault_domain of this CreateContainerInstanceDetails.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this CreateContainerInstanceDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns: The freeform_tags of this CreateContainerInstanceDetails.
Return type: dict(str, str)

property graceful_shutdown_timeout_in_seconds¶

Gets the graceful_shutdown_timeout_in_seconds of this CreateContainerInstanceDetails. The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.

Returns: The graceful_shutdown_timeout_in_seconds of this CreateContainerInstanceDetails.
Return type: int

property image_pull_secrets¶

Gets the image_pull_secrets of this CreateContainerInstanceDetails. The image pulls secrets so you can access private registry to pull container images.

Returns: The image_pull_secrets of this CreateContainerInstanceDetails.
Return type: list[oci.container_instances.models.CreateImagePullSecretDetails]

property security_context¶

Gets the security_context of this CreateContainerInstanceDetails.

Returns: The security_context of this CreateContainerInstanceDetails.
Return type: oci.container_instances.models.CreateContainerInstanceSecurityContextDetails

property shape¶

[Required] Gets the shape of this CreateContainerInstanceDetails. The shape of the container instance. The shape determines the resources available to the container instance.

Returns: The shape of this CreateContainerInstanceDetails.
Return type: str

property shape_config¶

[Required] Gets the shape_config of this CreateContainerInstanceDetails.

Returns: The shape_config of this CreateContainerInstanceDetails.
Return type: oci.container_instances.models.CreateContainerInstanceShapeConfigDetails

property vnics¶

[Required] Gets the vnics of this CreateContainerInstanceDetails. The networks available to containers on this container instance.

Returns: The vnics of this CreateContainerInstanceDetails.
Return type: list[oci.container_instances.models.CreateContainerVnicDetails]

property volumes¶

Gets the volumes of this CreateContainerInstanceDetails. A volume is a directory with data that is accessible across multiple containers in a container instance.

You can attach up to 32 volumes to single container instance.

Returns: The volumes of this CreateContainerInstanceDetails.
Return type: list[oci.container_instances.models.CreateContainerVolumeDetails]