com.pulumi.alicloud.eci.ContainerGroup Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of alicloud Show documentation
Show all versions of alicloud Show documentation
A Pulumi package for creating and managing AliCloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.alicloud.eci;
import com.pulumi.alicloud.Utilities;
import com.pulumi.alicloud.eci.ContainerGroupArgs;
import com.pulumi.alicloud.eci.inputs.ContainerGroupState;
import com.pulumi.alicloud.eci.outputs.ContainerGroupAcrRegistryInfo;
import com.pulumi.alicloud.eci.outputs.ContainerGroupContainer;
import com.pulumi.alicloud.eci.outputs.ContainerGroupDnsConfig;
import com.pulumi.alicloud.eci.outputs.ContainerGroupHostAlias;
import com.pulumi.alicloud.eci.outputs.ContainerGroupImageRegistryCredential;
import com.pulumi.alicloud.eci.outputs.ContainerGroupInitContainer;
import com.pulumi.alicloud.eci.outputs.ContainerGroupSecurityContext;
import com.pulumi.alicloud.eci.outputs.ContainerGroupVolume;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.Double;
import java.lang.Integer;
import java.lang.Object;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides ECI Container Group resource.
*
* For information about ECI Container Group and how to use it, see [What is Container Group](https://www.alibabacloud.com/help/en/elastic-container-instance/latest/api-eci-2018-08-08-createcontainergroup).
*
* > **NOTE:** Available since v1.111.0.
*
* ## Example Usage
*
* Basic Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.alicloud.eci.EciFunctions;
* import com.pulumi.alicloud.eci.inputs.GetZonesArgs;
* import com.pulumi.alicloud.vpc.Network;
* import com.pulumi.alicloud.vpc.NetworkArgs;
* import com.pulumi.alicloud.vpc.Switch;
* import com.pulumi.alicloud.vpc.SwitchArgs;
* import com.pulumi.alicloud.ecs.SecurityGroup;
* import com.pulumi.alicloud.ecs.SecurityGroupArgs;
* import com.pulumi.alicloud.eci.ContainerGroup;
* import com.pulumi.alicloud.eci.ContainerGroupArgs;
* import com.pulumi.alicloud.eci.inputs.ContainerGroupContainerArgs;
* import com.pulumi.alicloud.eci.inputs.ContainerGroupInitContainerArgs;
* import com.pulumi.alicloud.eci.inputs.ContainerGroupVolumeArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* final var config = ctx.config();
* final var name = config.get("name").orElse("tf-example");
* final var default = EciFunctions.getZones();
*
* var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
* .vpcName(name)
* .cidrBlock("10.0.0.0/8")
* .build());
*
* var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
* .vswitchName(name)
* .cidrBlock("10.1.0.0/16")
* .vpcId(defaultNetwork.id())
* .zoneId(default_.zones()[0].zoneIds()[0])
* .build());
*
* var defaultSecurityGroup = new SecurityGroup("defaultSecurityGroup", SecurityGroupArgs.builder()
* .name(name)
* .vpcId(defaultNetwork.id())
* .build());
*
* var defaultContainerGroup = new ContainerGroup("defaultContainerGroup", ContainerGroupArgs.builder()
* .containerGroupName(name)
* .cpu(8)
* .memory(16)
* .restartPolicy("OnFailure")
* .securityGroupId(defaultSecurityGroup.id())
* .vswitchId(defaultSwitch.id())
* .autoCreateEip(true)
* .tags(Map.ofEntries(
* Map.entry("Created", "TF"),
* Map.entry("For", "example")
* ))
* .containers(ContainerGroupContainerArgs.builder()
* .image("registry.cn-beijing.aliyuncs.com/eci_open/nginx:alpine")
* .name("nginx")
* .workingDir("/tmp/nginx")
* .imagePullPolicy("IfNotPresent")
* .commands(
* "/bin/sh",
* "-c",
* "sleep 9999")
* .volumeMounts(ContainerGroupContainerVolumeMountArgs.builder()
* .mountPath("/tmp/example")
* .readOnly(false)
* .name("empty1")
* .build())
* .ports(ContainerGroupContainerPortArgs.builder()
* .port(80)
* .protocol("TCP")
* .build())
* .environmentVars(ContainerGroupContainerEnvironmentVarArgs.builder()
* .key("name")
* .value("nginx")
* .build())
* .livenessProbes(ContainerGroupContainerLivenessProbeArgs.builder()
* .periodSeconds("5")
* .initialDelaySeconds("5")
* .successThreshold("1")
* .failureThreshold("3")
* .timeoutSeconds("1")
* .execs(ContainerGroupContainerLivenessProbeExecArgs.builder()
* .commands("cat /tmp/healthy")
* .build())
* .build())
* .readinessProbes(ContainerGroupContainerReadinessProbeArgs.builder()
* .periodSeconds("5")
* .initialDelaySeconds("5")
* .successThreshold("1")
* .failureThreshold("3")
* .timeoutSeconds("1")
* .execs(ContainerGroupContainerReadinessProbeExecArgs.builder()
* .commands("cat /tmp/healthy")
* .build())
* .build())
* .build())
* .initContainers(ContainerGroupInitContainerArgs.builder()
* .name("init-busybox")
* .image("registry.cn-beijing.aliyuncs.com/eci_open/busybox:1.30")
* .imagePullPolicy("IfNotPresent")
* .commands("echo")
* .args("hello initcontainer")
* .build())
* .volumes(
* ContainerGroupVolumeArgs.builder()
* .name("empty1")
* .type("EmptyDirVolume")
* .build(),
* ContainerGroupVolumeArgs.builder()
* .name("empty2")
* .type("EmptyDirVolume")
* .build())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* ECI Container Group can be imported using the id, e.g.
*
* ```sh
* $ pulumi import alicloud:eci/containerGroup:ContainerGroup example <container_group_id>
* ```
*
*/
@ResourceType(type="alicloud:eci/containerGroup:ContainerGroup")
public class ContainerGroup extends com.pulumi.resources.CustomResource {
/**
* The ACR enterprise edition example properties. See `acr_registry_info` below.
*
*/
@Export(name="acrRegistryInfos", refs={List.class,ContainerGroupAcrRegistryInfo.class}, tree="[0,1]")
private Output> acrRegistryInfos;
/**
* @return The ACR enterprise edition example properties. See `acr_registry_info` below.
*
*/
public Output>> acrRegistryInfos() {
return Codegen.optional(this.acrRegistryInfos);
}
/**
* Specifies whether to automatically create an EIP and bind the EIP to the elastic container instance.
*
*/
@Export(name="autoCreateEip", refs={Boolean.class}, tree="[0]")
private Output autoCreateEip;
/**
* @return Specifies whether to automatically create an EIP and bind the EIP to the elastic container instance.
*
*/
public Output> autoCreateEip() {
return Codegen.optional(this.autoCreateEip);
}
/**
* Specifies whether to automatically match the image cache. Default value: `false`. Valid values: `true` and `false`.
*
*/
@Export(name="autoMatchImageCache", refs={Boolean.class}, tree="[0]")
private Output autoMatchImageCache;
/**
* @return Specifies whether to automatically match the image cache. Default value: `false`. Valid values: `true` and `false`.
*
*/
public Output autoMatchImageCache() {
return this.autoMatchImageCache;
}
/**
* The name of the container group.
*
*/
@Export(name="containerGroupName", refs={String.class}, tree="[0]")
private Output containerGroupName;
/**
* @return The name of the container group.
*
*/
public Output containerGroupName() {
return this.containerGroupName;
}
/**
* The list of containers. See `containers` below.
*
*/
@Export(name="containers", refs={List.class,ContainerGroupContainer.class}, tree="[0,1]")
private Output> containers;
/**
* @return The list of containers. See `containers` below.
*
*/
public Output> containers() {
return this.containers;
}
/**
* The amount of CPU resources allocated to the container group.
*
*/
@Export(name="cpu", refs={Double.class}, tree="[0]")
private Output cpu;
/**
* @return The amount of CPU resources allocated to the container group.
*
*/
public Output cpu() {
return this.cpu;
}
/**
* The structure of dnsConfig. See `dns_config` below.
*
*/
@Export(name="dnsConfig", refs={ContainerGroupDnsConfig.class}, tree="[0]")
private Output dnsConfig;
/**
* @return The structure of dnsConfig. See `dns_config` below.
*
*/
public Output> dnsConfig() {
return Codegen.optional(this.dnsConfig);
}
/**
* The bandwidth of the EIP. Default value: `5`.
*
*/
@Export(name="eipBandwidth", refs={Integer.class}, tree="[0]")
private Output eipBandwidth;
/**
* @return The bandwidth of the EIP. Default value: `5`.
*
*/
public Output> eipBandwidth() {
return Codegen.optional(this.eipBandwidth);
}
/**
* The ID of the elastic IP address (EIP).
*
*/
@Export(name="eipInstanceId", refs={String.class}, tree="[0]")
private Output eipInstanceId;
/**
* @return The ID of the elastic IP address (EIP).
*
*/
public Output> eipInstanceId() {
return Codegen.optional(this.eipInstanceId);
}
/**
* HostAliases. See `host_aliases` below.
*
*/
@Export(name="hostAliases", refs={List.class,ContainerGroupHostAlias.class}, tree="[0,1]")
private Output> hostAliases;
/**
* @return HostAliases. See `host_aliases` below.
*
*/
public Output>> hostAliases() {
return Codegen.optional(this.hostAliases);
}
/**
* The image registry credential. See `image_registry_credential` below.
*
*/
@Export(name="imageRegistryCredentials", refs={List.class,ContainerGroupImageRegistryCredential.class}, tree="[0,1]")
private Output> imageRegistryCredentials;
/**
* @return The image registry credential. See `image_registry_credential` below.
*
*/
public Output>> imageRegistryCredentials() {
return Codegen.optional(this.imageRegistryCredentials);
}
/**
* The list of initContainers. See `init_containers` below.
*
*/
@Export(name="initContainers", refs={List.class,ContainerGroupInitContainer.class}, tree="[0,1]")
private Output> initContainers;
/**
* @return The list of initContainers. See `init_containers` below.
*
*/
public Output>> initContainers() {
return Codegen.optional(this.initContainers);
}
/**
* The address of the self-built mirror warehouse. When creating an image cache using an image in a self-built image repository with a self-signed certificate, you need to configure this parameter to skip certificate authentication to avoid image pull failure due to certificate authentication failure.
*
*/
@Export(name="insecureRegistry", refs={String.class}, tree="[0]")
private Output insecureRegistry;
/**
* @return The address of the self-built mirror warehouse. When creating an image cache using an image in a self-built image repository with a self-signed certificate, you need to configure this parameter to skip certificate authentication to avoid image pull failure due to certificate authentication failure.
*
*/
public Output> insecureRegistry() {
return Codegen.optional(this.insecureRegistry);
}
/**
* The type of the ECS instance.
*
*/
@Export(name="instanceType", refs={String.class}, tree="[0]")
private Output instanceType;
/**
* @return The type of the ECS instance.
*
*/
public Output instanceType() {
return this.instanceType;
}
/**
* (Available since v1.170.0) The Public IP of the container group.
*
*/
@Export(name="internetIp", refs={String.class}, tree="[0]")
private Output internetIp;
/**
* @return (Available since v1.170.0) The Public IP of the container group.
*
*/
public Output internetIp() {
return this.internetIp;
}
/**
* (Available since v1.170.0) The Private IP of the container group.
*
*/
@Export(name="intranetIp", refs={String.class}, tree="[0]")
private Output intranetIp;
/**
* @return (Available since v1.170.0) The Private IP of the container group.
*
*/
public Output intranetIp() {
return this.intranetIp;
}
/**
* The amount of memory resources allocated to the container group.
*
*/
@Export(name="memory", refs={Double.class}, tree="[0]")
private Output memory;
/**
* @return The amount of memory resources allocated to the container group.
*
*/
public Output memory() {
return this.memory;
}
/**
* The address of the self-built mirror warehouse. When creating an image cache from an image in a self-built image repository using the HTTP protocol, you need to configure this parameter so that the ECI uses the HTTP protocol to pull the image to avoid image pull failure due to different protocols.
*
*/
@Export(name="plainHttpRegistry", refs={String.class}, tree="[0]")
private Output plainHttpRegistry;
/**
* @return The address of the self-built mirror warehouse. When creating an image cache from an image in a self-built image repository using the HTTP protocol, you need to configure this parameter so that the ECI uses the HTTP protocol to pull the image to avoid image pull failure due to different protocols.
*
*/
public Output> plainHttpRegistry() {
return Codegen.optional(this.plainHttpRegistry);
}
/**
* The RAM role that the container group assumes. ECI and ECS share the same RAM role.
*
*/
@Export(name="ramRoleName", refs={String.class}, tree="[0]")
private Output ramRoleName;
/**
* @return The RAM role that the container group assumes. ECI and ECS share the same RAM role.
*
*/
public Output> ramRoleName() {
return Codegen.optional(this.ramRoleName);
}
/**
* The ID of the resource group. **NOTE:** From version 1.208.0, `resource_group_id` can be modified.
*
*/
@Export(name="resourceGroupId", refs={String.class}, tree="[0]")
private Output resourceGroupId;
/**
* @return The ID of the resource group. **NOTE:** From version 1.208.0, `resource_group_id` can be modified.
*
*/
public Output resourceGroupId() {
return this.resourceGroupId;
}
/**
* The restart policy of the container group. Valid values: `Always`, `Never`, `OnFailure`.
*
*/
@Export(name="restartPolicy", refs={String.class}, tree="[0]")
private Output restartPolicy;
/**
* @return The restart policy of the container group. Valid values: `Always`, `Never`, `OnFailure`.
*
*/
public Output restartPolicy() {
return this.restartPolicy;
}
/**
* The security context of the container group. See `security_context` below.
*
*/
@Export(name="securityContext", refs={ContainerGroupSecurityContext.class}, tree="[0]")
private Output securityContext;
/**
* @return The security context of the container group. See `security_context` below.
*
*/
public Output> securityContext() {
return Codegen.optional(this.securityContext);
}
/**
* The ID of the security group to which the container group belongs. Container groups within the same security group can access each other.
*
*/
@Export(name="securityGroupId", refs={String.class}, tree="[0]")
private Output securityGroupId;
/**
* @return The ID of the security group to which the container group belongs. Container groups within the same security group can access each other.
*
*/
public Output securityGroupId() {
return this.securityGroupId;
}
/**
* The maximum hourly price of the ECI spot instance.
*
*/
@Export(name="spotPriceLimit", refs={Double.class}, tree="[0]")
private Output spotPriceLimit;
/**
* @return The maximum hourly price of the ECI spot instance.
*
*/
public Output spotPriceLimit() {
return this.spotPriceLimit;
}
/**
* Filter the results by ECI spot type. Valid values: `NoSpot`, `SpotWithPriceLimit` and `SpotAsPriceGo`. Default to `NoSpot`.
*
*/
@Export(name="spotStrategy", refs={String.class}, tree="[0]")
private Output spotStrategy;
/**
* @return Filter the results by ECI spot type. Valid values: `NoSpot`, `SpotWithPriceLimit` and `SpotAsPriceGo`. Default to `NoSpot`.
*
*/
public Output spotStrategy() {
return this.spotStrategy;
}
/**
* The status of container group.
*
*/
@Export(name="status", refs={String.class}, tree="[0]")
private Output status;
/**
* @return The status of container group.
*
*/
public Output status() {
return this.status;
}
/**
* A mapping of tags to assign to the resource.
* - Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
* - Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
*
*/
@Export(name="tags", refs={Map.class,String.class,Object.class}, tree="[0,1,2]")
private Output> tags;
/**
* @return A mapping of tags to assign to the resource.
* - Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
* - Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* The buffer time during which the program handles operations before the program stops. Unit: seconds.
*
*/
@Export(name="terminationGracePeriodSeconds", refs={Integer.class}, tree="[0]")
private Output terminationGracePeriodSeconds;
/**
* @return The buffer time during which the program handles operations before the program stops. Unit: seconds.
*
*/
public Output> terminationGracePeriodSeconds() {
return Codegen.optional(this.terminationGracePeriodSeconds);
}
/**
* The list of volumes. See `volumes` below.
*
*/
@Export(name="volumes", refs={List.class,ContainerGroupVolume.class}, tree="[0,1]")
private Output> volumes;
/**
* @return The list of volumes. See `volumes` below.
*
*/
public Output>> volumes() {
return Codegen.optional(this.volumes);
}
/**
* The ID of the VSwitch. Currently, container groups can only be deployed in VPC networks. The number of IP addresses in the VSwitch CIDR block determines the maximum number of container groups that can be created in the VSwitch. Before you can create an ECI instance, plan the CIDR block of the VSwitch.
* **NOTE:** From version 1.208.0, You can specify up to 10 `vswitch_id`. Separate multiple vSwitch IDs with commas (,), such as vsw-***,vsw-***. attribute `vswitch_id` updating diff will be ignored when you set multiple vSwitchIds, there is only one valid `vswitch_id` exists in the set vSwitchIds.
*
*/
@Export(name="vswitchId", refs={String.class}, tree="[0]")
private Output vswitchId;
/**
* @return The ID of the VSwitch. Currently, container groups can only be deployed in VPC networks. The number of IP addresses in the VSwitch CIDR block determines the maximum number of container groups that can be created in the VSwitch. Before you can create an ECI instance, plan the CIDR block of the VSwitch.
* **NOTE:** From version 1.208.0, You can specify up to 10 `vswitch_id`. Separate multiple vSwitch IDs with commas (,), such as vsw-***,vsw-***. attribute `vswitch_id` updating diff will be ignored when you set multiple vSwitchIds, there is only one valid `vswitch_id` exists in the set vSwitchIds.
*
*/
public Output vswitchId() {
return this.vswitchId;
}
/**
* The ID of the zone where you want to deploy the container group. If no value is specified, the system assigns a zone to the container group. By default, no value is specified.
*
*/
@Export(name="zoneId", refs={String.class}, tree="[0]")
private Output zoneId;
/**
* @return The ID of the zone where you want to deploy the container group. If no value is specified, the system assigns a zone to the container group. By default, no value is specified.
*
*/
public Output zoneId() {
return this.zoneId;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public ContainerGroup(String name) {
this(name, ContainerGroupArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public ContainerGroup(String name, ContainerGroupArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public ContainerGroup(String name, ContainerGroupArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("alicloud:eci/containerGroup:ContainerGroup", name, args == null ? ContainerGroupArgs.Empty : args, makeResourceOptions(options, Codegen.empty()));
}
private ContainerGroup(String name, Output id, @Nullable ContainerGroupState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("alicloud:eci/containerGroup:ContainerGroup", name, state, makeResourceOptions(options, id));
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static ContainerGroup get(String name, Output id, @Nullable ContainerGroupState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new ContainerGroup(name, id, state, options);
}
}