Package com.pulumi.aws.eks
Class Addon
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.eks.Addon
-
public class Addon extends com.pulumi.resources.CustomResourceManages an EKS add-on. ## Example Usage
### Example Update add-on usage with resolveConflictsOnUpdate and PRESERVE `resolveConflictsOnUpdate` with `PRESERVE` can be used to retain the config changes applied to the add-on with kubectl while upgrading to a newer version of the add-on.package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.eks.Addon; import com.pulumi.aws.eks.AddonArgs; import java.util.ArrayList; import java.util.Arrays; 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) { var example = new Addon("example", AddonArgs.builder() .clusterName(exampleAwsEksCluster.name()) .addonName("vpc-cni") .build()); } }
### Example add-on usage with custom configurationValues Custom add-on configuration can be passed using `configurationValues` as a single JSON string while creating or updating the add-on. > **Note:** `configurationValues` is a single JSON string should match the valid JSON schema for each add-on with specific version. You can use [describe-addon-configuration](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-configuration.html) to extract each add-on's JSON schema. Here's an example command to extract the `configurationValues` schema for `coredns`. Example to create a `coredns` managed addon with custom `configurationValues`.package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.eks.Addon; import com.pulumi.aws.eks.AddonArgs; import java.util.ArrayList; import java.util.Arrays; 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) { var example = new Addon("example", AddonArgs.builder() .clusterName(exampleAwsEksCluster.name()) .addonName("coredns") .addonVersion("v1.10.1-eksbuild.1") .resolveConflictsOnUpdate("PRESERVE") .build()); } }
#### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Add-Ons using `clusterName` and `addonName` separated by a colon (`:`). For example: ```sh $ pulumi import aws:eks/addon:Addon example example-cluster:example-addon ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.eks.Addon; import com.pulumi.aws.eks.AddonArgs; import static com.pulumi.codegen.internal.Serialization.*; import java.util.ArrayList; import java.util.Arrays; 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) { var example = new Addon("example", AddonArgs.builder() .clusterName("mycluster") .addonName("coredns") .addonVersion("v1.10.1-eksbuild.1") .resolveConflictsOnCreate("OVERWRITE") .configurationValues(serializeJson( jsonObject( jsonProperty("replicaCount", 4), jsonProperty("resources", jsonObject( jsonProperty("limits", jsonObject( jsonProperty("cpu", "100m"), jsonProperty("memory", "150Mi") )), jsonProperty("requests", jsonObject( jsonProperty("cpu", "100m"), jsonProperty("memory", "150Mi") )) )) ))) .build()); } }
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>addonName()com.pulumi.core.Output<java.lang.String>addonVersion()com.pulumi.core.Output<java.lang.String>arn()com.pulumi.core.Output<java.lang.String>clusterName()com.pulumi.core.Output<java.lang.String>configurationValues()com.pulumi.core.Output<java.lang.String>createdAt()static Addonget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AddonState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>modifiedAt()com.pulumi.core.Output<AddonNamespaceConfig>namespaceConfig()com.pulumi.core.Output<java.util.Optional<java.util.List<AddonPodIdentityAssociation>>>podIdentityAssociations()com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>>preserve()com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.util.Optional<java.lang.String>>resolveConflictsOnCreate()com.pulumi.core.Output<java.util.Optional<java.lang.String>>resolveConflictsOnUpdate()com.pulumi.core.Output<java.util.Optional<java.lang.String>>serviceAccountRoleArn()com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>tags()com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>tagsAll()
-
-
-
Constructor Detail
-
Addon
public Addon(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
Addon
public Addon(java.lang.String name, AddonArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
Addon
public Addon(java.lang.String name, AddonArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
addonName
public com.pulumi.core.Output<java.lang.String> addonName()
- Returns:
- Name of the EKS add-on. The name must match one of the names returned by [describe-addon-versions](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-versions.html).
-
addonVersion
public com.pulumi.core.Output<java.lang.String> addonVersion()
- Returns:
- The version of the EKS add-on. The version must match one of the versions returned by [describe-addon-versions](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-versions.html).
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- ARN of the EKS add-on.
-
clusterName
public com.pulumi.core.Output<java.lang.String> clusterName()
- Returns:
- Name of the EKS Cluster. The following arguments are optional:
-
configurationValues
public com.pulumi.core.Output<java.lang.String> configurationValues()
- Returns:
- Custom configuration values for addons with single JSON string. This JSON string value must match the JSON schema derived from [describe-addon-configuration](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-configuration.html).
-
createdAt
public com.pulumi.core.Output<java.lang.String> createdAt()
- Returns:
- Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was created.
-
modifiedAt
public com.pulumi.core.Output<java.lang.String> modifiedAt()
- Returns:
- Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was updated.
-
namespaceConfig
public com.pulumi.core.Output<AddonNamespaceConfig> namespaceConfig()
- Returns:
- Namespace configuration for the add-on. See `namespaceConfig` below for details.
-
podIdentityAssociations
public com.pulumi.core.Output<java.util.Optional<java.util.List<AddonPodIdentityAssociation>>> podIdentityAssociations()
- Returns:
- Configuration block with EKS Pod Identity association settings. See `podIdentityAssociation` below for details.
-
preserve
public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> preserve()
- Returns:
- Indicates if you want to preserve the created resources when deleting the EKS add-on.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
resolveConflictsOnCreate
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> resolveConflictsOnCreate()
- Returns:
- How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are `NONE` and `OVERWRITE`. For more details see the [CreateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateAddon.html) API Documentation.
-
resolveConflictsOnUpdate
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> resolveConflictsOnUpdate()
- Returns:
- How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are `NONE`, `OVERWRITE`, and `PRESERVE`. For more details see the [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html) API Documentation.
-
serviceAccountRoleArn
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> serviceAccountRoleArn()
- Returns:
- ARN of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see [Amazon EKS node IAM role](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) in the Amazon EKS User Guide. > **Note:** To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, [see Enabling IAM roles for service accounts on your cluster](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) in the Amazon EKS User Guide.
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- (Optional) Key-value map of resource tags, including those inherited from the provider `defaultTags` configuration block.
-
get
public static Addon get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable AddonState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-