Package software.amazon.awssdk.services.greengrassv2.model

Interface CreateDeploymentRequest.Builder

    • Method Detail

      • targetArn

        CreateDeploymentRequest.Builder targetArn​(String targetArn)

        The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.

        Parameters:
        targetArn - The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deploymentName

        CreateDeploymentRequest.Builder deploymentName​(String deploymentName)

        The name of the deployment.

        Parameters:
        deploymentName - The name of the deployment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • components

        CreateDeploymentRequest.Builder components​(Map<String,​ComponentDeploymentSpecification> components)

        The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

        Parameters:
        components - The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iotJobConfiguration

        CreateDeploymentRequest.Builder iotJobConfiguration​(DeploymentIoTJobConfiguration iotJobConfiguration)

        The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

        Parameters:
        iotJobConfiguration - The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deploymentPolicies

        CreateDeploymentRequest.Builder deploymentPolicies​(DeploymentPolicies deploymentPolicies)

        The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

        Parameters:
        deploymentPolicies - The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parentTargetArn

        CreateDeploymentRequest.Builder parentTargetArn​(String parentTargetArn)

        The parent deployment's target ARN within a subdeployment.

        Parameters:
        parentTargetArn - The parent deployment's target ARN within a subdeployment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDeploymentRequest.Builder tags​(Map<String,​String> tags)

        A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

        Parameters:
        tags - A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        CreateDeploymentRequest.Builder clientToken​(String clientToken)

        A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.

        Parameters:
        clientToken - A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
        Returns:
        Returns a reference to this object so that method calls can be chained together.